View source code
Display the source code in dmd/lexer.d from which this page was generated on github.
Report a bug
If you spot a problem with this page, click here to create a Bugzilla issue.
Improve this page
Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Class dmd.lexer.Lexer

class Lexer ;

Constructors

NameDescription
this (filename, base, begoffset, endoffset, doDocComment, commentToken, errorSink, compileEnv) Creates a Lexer for the source code base[begoffset..endoffset+1]. The last character, base[endoffset], must be null (0) or EOF (0x1A).
this (filename, base, begoffset, endoffset, doDocComment, commentToken, whitespaceToken, errorSink, compileEnv) Alternative entry point for DMDLIB, adds whitespaceToken
this (errorSink) Used for unittests for a mock Lexer

Fields

NameTypeDescription
boolsize ubytesize of a C Bool, default 1
Ccompile booltrue if compiling ImportC
compileEnv CompileEnvenvironment
eSink ErrorSinksend error messages through this interface
intsize ubytesize of a C int, default 4
long_doublesize ubytesize of C long double, 8 or D real.sizeof
long_longsize ubytesize of a C long long, default 8
longsize ubytesize of C long, 4 or 8
shortsize ubytesize of a C short, default 2
wchar_tsize ubytesize of C wchar_t, 2 or 4

Properties

NameTypeDescription
empty[get] boolRange interface

Methods

NameDescription
allocateToken ()
combineComments (c1, c2, newParagraph) Combine two document comments into one, separated by an extra newline if newParagraph is true.
hexStringConstant (t) Lex hex strings: x"0A ae 34FE BD"
nextDefineLine () Set up for next #define line. p should be at start of next line.
parseSpecialTokenSequence () Parse special token sequence:
peekNext () Look ahead at next token's value.
peekNext2 () Look 2 tokens ahead at value.
peekPastParen (tk) tk is on the opening (. Look ahead and return token that is past the closing ).
poundLine (tok, linemarker) Parse line/file preprocessor directive: #line linnum [filespec] Allow _LINE__ for linnum, and _FILE__ for filespec. Accept linemarker format: # linnum [filespec] {flags} There can be zero or more flags, which are one of the digits 1..4, and must be in ascending order. The flags are ignored.
printRestOfTokens () Print the tokens from the current token to the end, while not advancing the parser forward. Useful for debugging.
resetDefineLines (slice) Reset lexer to lex #define's
scan (t) Turn next token in buffer into a token.
skipToNextLine (defines) Scan forward to start of next line.
factory (classname) Create instance of class specified by the fully qualified name classname. The class must either have no constructors or have a default constructor.
opCmp (o) Compare with another Object obj.
opEquals (o) Test whether this is equal to o. The default implementation only compares by identity (using the is operator). Generally, overrides and overloads for opEquals should attempt to compare objects by their contents. A class will most likely want to add an overload that takes your specific type as the argument and does the content comparison. Then you can override this and forward it to your specific typed overload with a cast. Remember to check for null on the typed overload.
toHash () Compute hash function for Object.
toString () Convert Object to a human readable string.

Authors

Walter Bright

License

Boost License 1.0