Parsing¶

This section contains definitions declared in the chpl::parsing namespace.

namespace chpl::parsing¶

Typedefs

using ConfigSettingsList = std::vector<std::pair<std::string, std::string>>¶

using ModuleVec = std::vector<const uast::Module*>¶

Functions

const FileContents &fileText(Context *context, std::string path)¶: This query returns the contents of a file as the string field in the FileContents. In case there is an error reading the file, the error is stored in the error field of the FileContents.

const FileContents &fileText(Context *context, UniqueString path)¶: Convenience function to call fileText given a UniqueString.

void setFileText(Context *context, std::string path, FileContents result)¶: This function sets the FileContents that will be returned by the fileText query above.

void setFileText(Context *context, std::string path, std::string text)¶: This function sets the string that will be returned by the fileText query above. The FileContents stored will have an empty ErrorMessage field.

void setFileText(Context *context, UniqueString path, std::string text)¶: This function sets the string that will be returned by the fileText query above. The FileContents stored will have an empty ErrorMessage field.

bool hasFileText(Context *context, const std::string &path)¶: This function returns true if the current revision already has contents stored in the fileText query for the given path.

const uast::BuilderResult &parseFile(Context *context, UniqueString path)¶

This query reads a file (with the fileText query) and then parses it.

Any errors encountered will be reported to the Context.

void countTokens(Context *context, UniqueString path, ParserStats *parseStats)¶: A function for counting the tokens when parsing

const Location &locateId(Context *context, ID id)¶: This query returns the Location where a particular ID appeared. It cannot be used for Comments because Comments don’t have IDs set. If Locations for Comments are needed, use uast::BuilderResult::commentToLocation

const Location &locateAst(Context *context, const uast::AstNode *ast)¶: This function just runs locateId on ast->id(). Similarly to locateID, it cannot be used to get a Location for a Comment.

const ModuleVec &parse(Context *context, UniqueString path)¶: This query returns a vector of parsed modules given a file path.

const std::vector<UniqueString> &moduleSearchPath(Context *context)¶: Return the current module search path.

void setModuleSearchPath(Context *context, std::vector<UniqueString> searchPath)¶: Sets the current module search path.

UniqueString internalModulePath(Context *context)¶: Return the current internal module path, i.e. CHPL_HOME/modules/internal/

void setInternalModulePath(Context *context, UniqueString path)¶: Set the current internal modules directory, i.e. CHPL_HOME/modules/internal/ This should be formed in a consistent manner with setModuleSearchPath, so that this is a prefix for some module search paths.

UniqueString bundledModulePath(Context *context)¶: Return the current standard module path, i.e. CHPL_HOME/modules/

void setBundledModulePath(Context *context, UniqueString path)¶: Set the current bundled modules directory, i.e. CHPL_HOME/modules/ This should be formed in a consistent manner with setModuleSearchPath, so that this is a prefix for some module search paths.

void setupModuleSearchPaths(Context *context, const std::string &chplHome, bool minimalModules, const std::string &chplLocaleModel, bool enableTaskTracking, const std::string &chplTasks, const std::string &chplComm, const std::string &chplSysModulesSubdir, const std::string &chplModulePath, const std::vector<std::string> &cmdLinePaths)¶

Helper to call setModuleSearchPath, setInternalModulePath, standardModulePath. This function accepts the path to CHPL_HOME, and any additional module path components (from environment variable and command line).

Most of these arguments have corresponding env / printchplenv settings: chplHome CHPL_HOME chplLocaleModel CHPL_LOCALE_MODEL chplTasks CHPL_TASKS chplComm CHPL_COMM chplSysModulesSubdir CHPL_SYS_MODULES_SUBDIR chplModulePath CHPL_MODULE_PATH

bool idIsInInternalModule(Context *context, ID id)¶: Returns true if the ID corresponds to something in an internal module.

bool idIsInBundledModule(Context *context, ID id)¶: Returns true if the ID corresponds to something in a bundled module.

const uast::Module *getToplevelModule(Context *context, UniqueString name)¶: This query parses a toplevel module by name. Returns nullptr if no such toplevel module can be found in the module search path.

const uast::AstNode *idToAst(Context *context, ID id)¶: Returns the uast node with the given ID.

uast::AstTag idToTag(Context *context, ID id)¶: Returns the tag for the node with the given ID.

bool idIsParenlessFunction(Context *context, ID id)¶: Returns true if the ID is a parenless function.

const ID &idToParentId(Context *context, ID id)¶: Returns the parent ID given an ID

uast::Function::ReturnIntent idToFnReturnIntent(Context *context, ID id)¶: Given an ID that represents a Function, get the declared return intent for that function.

bool idIsFunctionWithWhere(Context *context, ID id)¶: Returns ‘true’ if the passed ID represents a Function with a where clause, and ‘false’ otherwise.

ID idToContainingMultiDeclId(Context *context, ID id)¶: Given an ID for a Variable, returns the ID of the containing MultiDecl or TupleDecl, if any, and the ID of the variable otherwise.

bool idContainsFieldWithName(Context *context, ID typeDeclId, UniqueString fieldName)¶: Given an ID for a Record/Union/Class Decl, returns ‘true’ if the passed name is the name of a field contained in it.

ID fieldIdWithName(Context *context, ID typeDeclId, UniqueString fieldName)¶: Given an ID for a Record/Union/Class Decl, and a field name, returns the ID for the Variable declaring that field.

void setConfigSettings(Context *context, ConfigSettingsList keys)¶: Store config settings that were set from the command line using -s flags

const ConfigSettingsList &configSettings(Context *context)¶: Get any config settings that were set from the command line and stored

class FileContents¶

#include <FileContents.h>

This class represents the result of reading a file.

Public Functions

inline FileContents()¶: Construct a FileContents containing empty text and no error

inline FileContents(std::string text)¶: Construct a FileContents containing the passed text and no error

inline FileContents(std::string text, ErrorMessage error)¶: Construct a FileContents containing the passed text and error

inline const std::string &text() const¶: Return a reference to the contents of this file

inline const ErrorMessage &error() const¶: Return a reference to an error encountered when reading this file

inline bool operator==(const FileContents &other) const¶

inline bool operator!=(const FileContents &other) const¶

inline void swap(FileContents &other)¶

inline void mark(Context *context) const¶

Public Static Functions

static inline bool update(FileContents &keep, FileContents &addin)¶

class Parser¶

#include <Parser.h>

A class for parsing

Public Functions

~Parser() = default¶

inline Context *context()¶: Return the AST Context used by this Parser.

uast::BuilderResult parseFile(const char *path, ParserStats *parseStats = nullptr)¶: Parse a file at a particular path.

uast::BuilderResult parseString(const char *path, const char *str, ParserStats *parseStats = nullptr)¶: Parse source code in a string. ‘path’ is only used for certain errors.

Public Static Functions

static owned<Parser> build(Context *context)¶

struct ParserStats¶

Public Functions

ParserStats()¶

ParserStats(bool printTokens)¶