WsfParseSourceInclude Class Reference

#include <WsfParseSourceInclude.hpp>

Collaboration diagram for WsfParseSourceInclude:

Classes
class	Entry

Public Types
enum	EntryType {   cINCLUDE_COMMAND , cLINE_COMMENT , cBLOCK_COMMENT , cPREPROCESSOR_DEFINE ,   cPREPROCESSOR_VARIABLE }

Public Member Functions
	WsfParseSourceInclude ()
	WsfParseSourceInclude (const WsfParseSourceInclude &)=delete
	WsfParseSourceInclude (WsfParseSourceInclude &&)=default
WsfParseSourceInclude &	operator= (const WsfParseSourceInclude &)=delete
WsfParseSourceInclude &	operator= (WsfParseSourceInclude &&)=default
	~WsfParseSourceInclude ()
void	AddInclude (const UtTextRange &aRange, UtTextDocument *aSourcePtr)
void	AddInclude (const UtTextRange &aRange, WsfParseSourceInclude *aIncludePtr)
void	AddVirtualInclude (WsfParseSourceInclude *aIncludePtr)
void	AddComment (const UtTextRange &aRange, bool aIsLineComment)
void	AddPreprocessorEntry (EntryType aEntryType, const UtTextRange &aRange)
WsfParseSourceIncludeId	GetId () const
WsfParseSourceInclude *	GetRoot ()

Static Public Member Functions
static bool	IsValidLocation (int aLocation)

Public Attributes
UtTextRange	mLocation
	The location of the include directive. This can be null for the 'main' input file.
WsfParseSourceInclude *	mParentPtr
UtTextDocument *	mSourcePtr
size_t	mIncludeCount
	The number of times this file has been included.
std::vector< Entry >	mEntries

Static Public Attributes
static constexpr std::size_t	cVIRTUAL_LOCATION = 0x0fffffff
static const UtTextRange	cVIRTUAL_RANGE

Detailed Description

Represents an instance where a file is included. include_once where the file has already been used does not result in a WsfParseSourceInclude. Most of the time There is a 1-to-1 correlation between this class and UtTextDocument. This is primarily required for strange usage of include.

Member Enumeration Documentation

EntryType

enum WsfParseSourceInclude::EntryType

Enumerator
cINCLUDE_COMMAND
cLINE_COMMENT
cBLOCK_COMMENT
cPREPROCESSOR_DEFINE
cPREPROCESSOR_VARIABLE

Constructor & Destructor Documentation

WsfParseSourceInclude() [1/3]

WsfParseSourceInclude::WsfParseSourceInclude ( )

inline

References mIncludeCount, mParentPtr, and mSourcePtr.

Referenced by AddInclude(), AddVirtualInclude(), GetRoot(), operator=(), operator=(), WsfParseSourceInclude(), and WsfParseSourceInclude().

WsfParseSourceInclude() [2/3]

WsfParseSourceInclude::WsfParseSourceInclude ( const WsfParseSourceInclude & )

delete

References WsfParseSourceInclude().

WsfParseSourceInclude() [3/3]

WsfParseSourceInclude::WsfParseSourceInclude ( WsfParseSourceInclude && )

default

References WsfParseSourceInclude().

~WsfParseSourceInclude()

WsfParseSourceInclude::~WsfParseSourceInclude

(

)

References mEntries, and mParentPtr.

Member Function Documentation

AddComment()

void WsfParseSourceInclude::AddComment	(	const UtTextRange &	aRange,
		bool	aIsLineComment )

Adds a comment entry

Parameters

aRange	is the location of the comment in the input file
aIsLineComment	is whether the comment is a line (# or //) comment

References cBLOCK_COMMENT, cLINE_COMMENT, mEntries, WsfParseSourceInclude::Entry::mLocation, and WsfParseSourceInclude::Entry::mType.

Referenced by operator=().

AddInclude() [1/2]

void WsfParseSourceInclude::AddInclude	(	const UtTextRange &	aRange,
		UtTextDocument *	aSourcePtr )

References cINCLUDE_COMMAND, mEntries, WsfParseSourceInclude::Entry::mLocation, WsfParseSourceInclude::Entry::mTargetSource, and WsfParseSourceInclude::Entry::mType.

Referenced by operator=().

AddInclude() [2/2]

void WsfParseSourceInclude::AddInclude	(	const UtTextRange &	aRange,
		WsfParseSourceInclude *	aIncludePtr )

References cINCLUDE_COMMAND, mEntries, WsfParseSourceInclude::Entry::mIncludePtr, WsfParseSourceInclude::Entry::mLocation, mSourcePtr, WsfParseSourceInclude::Entry::mTargetSource, WsfParseSourceInclude::Entry::mType, and WsfParseSourceInclude().

AddPreprocessorEntry()

void WsfParseSourceInclude::AddPreprocessorEntry	(	EntryType	aEntryType,
		const UtTextRange &	aRange )

References mEntries, WsfParseSourceInclude::Entry::mLocation, and WsfParseSourceInclude::Entry::mType.

Referenced by operator=().

AddVirtualInclude()

void WsfParseSourceInclude::AddVirtualInclude

(

WsfParseSourceInclude *

aIncludePtr

)

References cINCLUDE_COMMAND, cVIRTUAL_RANGE, mEntries, WsfParseSourceInclude::Entry::mIncludePtr, WsfParseSourceInclude::Entry::mLocation, mSourcePtr, WsfParseSourceInclude::Entry::mTargetSource, WsfParseSourceInclude::Entry::mType, and WsfParseSourceInclude().

Referenced by operator=().

GetId()

WsfParseSourceIncludeId WsfParseSourceInclude::GetId ( ) const

inline

References mIncludeCount, and mSourcePtr.

GetRoot()

WsfParseSourceInclude * WsfParseSourceInclude::GetRoot

(

)

References mParentPtr, and WsfParseSourceInclude().

IsValidLocation()

bool WsfParseSourceInclude::IsValidLocation ( int aLocation )

inlinestatic

operator=() [1/2]

WsfParseSourceInclude & WsfParseSourceInclude::operator= ( const WsfParseSourceInclude & )

delete

References WsfParseSourceInclude().

operator=() [2/2]

WsfParseSourceInclude & WsfParseSourceInclude::operator= ( WsfParseSourceInclude && )

default

References AddComment(), AddInclude(), AddPreprocessorEntry(), AddVirtualInclude(), and WsfParseSourceInclude().

Member Data Documentation

cVIRTUAL_LOCATION

std::size_t WsfParseSourceInclude::cVIRTUAL_LOCATION = 0x0fffffff

staticconstexpr

cVIRTUAL_RANGE

const UtTextRange WsfParseSourceInclude::cVIRTUAL_RANGE

static

Initial value:

{WsfParseSourceInclude::cVIRTUAL_LOCATION,
                                                        WsfParseSourceInclude::cVIRTUAL_LOCATION}

Referenced by AddVirtualInclude().

mEntries

std::vector<Entry> WsfParseSourceInclude::mEntries

Referenced by AddComment(), AddInclude(), AddInclude(), AddPreprocessorEntry(), AddVirtualInclude(), wizard::ParseResults::FindIncludeAtPoint(), wizard::ParseResults::FindIncludes(), wizard::ParseResults::GetFileNotifications(), wizard::EditAssist_Include::SetIncludeData(), wizard::WsfStyler::UpdateStyle(), and ~WsfParseSourceInclude().

mIncludeCount

size_t WsfParseSourceInclude::mIncludeCount

The number of times this file has been included.

Referenced by GetId(), and WsfParseSourceInclude().

mLocation

UtTextRange WsfParseSourceInclude::mLocation

The location of the include directive. This can be null for the 'main' input file.

mParentPtr

WsfParseSourceInclude* WsfParseSourceInclude::mParentPtr

Referenced by GetRoot(), WsfParseSourceInclude(), and ~WsfParseSourceInclude().

mSourcePtr

UtTextDocument* WsfParseSourceInclude::mSourcePtr

Referenced by AddInclude(), AddVirtualInclude(), wizard::ParseResults::FindIncludes(), wizard::ParseResults::GetFileNotifications(), GetId(), and WsfParseSourceInclude().

---

The documentation for this class was generated from the following files:

• WsfParseSourceInclude.hpp
• WsfParseSourceInclude.cpp