dxl::ExclamationFile::Entry Class Reference

Description:

An entry of the exclamation file.

Definition at line 25 of file exclamations.hpp.

#include <exclamations.hpp>

Public Method Index:
	Entry (alib::String filePath, int line, int column, int definitionLine)
bool	Matches (int line, int column)

Protected Field Index:
int	Column
	The column in Line in FilePath of the exclamation.
int	DefinitionLine
	The line number in FilePath that this entry was defined at.
alib::String128	FilePath
	The path or a portion of it of the HTML file that the exclamation is defined for.
int	Line
	The line number in FilePath of the exclamation.
bool	Used

Friends And Related Entity Details:

ExclamationFile

friend struct ExclamationFile

friend

Definition at line 26 of file exclamations.hpp.

Field Details:

Column

int dxl::ExclamationFile::Entry::Column

protected

The column in Line in FilePath of the exclamation.

Definition at line 36 of file exclamations.hpp.

DefinitionLine

int dxl::ExclamationFile::Entry::DefinitionLine

protected

The line number in FilePath that this entry was defined at.

The line number of the exclamation file.

Definition at line 39 of file exclamations.hpp.

FilePath

alib::String128 dxl::ExclamationFile::Entry::FilePath

protected

The path or a portion of it of the HTML file that the exclamation is defined for.

Definition at line 30 of file exclamations.hpp.

Line

int dxl::ExclamationFile::Entry::Line

protected

The line number in FilePath of the exclamation.

Definition at line 33 of file exclamations.hpp.

Used

bool dxl::ExclamationFile::Entry::Used

protected

Is set when this entry was used. When the program exits, all entries that have not been hit are displayed.

Definition at line 43 of file exclamations.hpp.

Constructor(s) / Destructor Details:

Entry()

dxl::ExclamationFile::Entry::Entry ( alib::String filePath, int line, int column, int definitionLine )

inline

Constructs an entry.

Parameters

filePath	Assigned to the field member FilePath.
line	Assigned to the field member Line.
column	Assigned to the field member Column.
definitionLine	Assigned to the field member DefinitionLine.

Definition at line 51 of file exclamations.hpp.

Method Details:

Matches()

bool dxl::ExclamationFile::Entry::Matches ( int line, int column )

inline

Tests if the given pair of line and colum are equal to what is defined with this rule.

Parameters

line	The line to test.
column	The colum to test.

Returns

true if this exclamation denotes the given position, false otherwise.

Definition at line 60 of file exclamations.hpp.

---

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

• exclamations.hpp