Abstract class for a parser for structure embedded in file definitions. It's class-name (used for any type of code generation) is "tgl_structure_parser".

The namespace within the parent namespace is "ph:tools:tangle".

The object fits into the tree of objects in the following way. Click on other objects in to navigate to that object. Objects to the left of this object are superclasses, and objects listed below it derive from this one.

• All Objects -> Standalone classes -> tgl_structure_parser
  • tgl_block_parser
  • tgl_forlist_parser

Here is a list of all uses of this object inside others. Click on the object to take you to the definition.

• Member "filedef" in tgl_foreachobject_visitor
• Argument "filedef" of @condition : pass
• Argument "filedef" of @block : output
• Argument "filedef" of @block : pass
• Argument "filedef" of includes : collect_typename
• Argument "filedef" of forwards : declare_reftype
• Argument "filedef" of foreachobject : parse
• Argument "filedef" of webtangle : search_section
• Argument "filedef" of webtangle : write_section
• Argument "filedef" of webtangle : write_source

Click here to see a tree representation of all objects.

Click here to return to the main index page.

Members

This object contains members which hold data for the object. Following is a list of those members. The declaration of the member closely follows the UML conventions.

stream : streamptrtype

Not sure.

console : streamptrtype

Not sure.

schemapath : pathtype

Not sure.

filepath : pathtype

Not sure.

command : stringtype

Not sure.

vars : stringmaptype

Not sure.

first : booltype

Not sure.

Methods

This object contains methods which can be called from other objects. Following is a list of those methods. The syntax of the method, it's arguments and return value follow closely the UML conventions.

• Constructors
  • (stream: streamptrtype, console: streamptrtype, schemapath: pathtype, filepath: pathtype)
  • (parser: Pointer to tgl_structure_parser)
• Destructor
• Abstract methods
  • do_block(block: stringtype): booltype
  • get_block(block: stringtype): stringtype
• Concrete methods
  • write_output(s: stringtype): booltype
  • write_output(c: chartype): booltype
  • error(error: stringtype): voidtype
  • console(): streamptrtype
  • get_filepath(): pathtype
• Concrete methods (private)
  • set_variable(var: stringtype, value: stringtype): voidtype
  • get_variable(var: stringtype): stringtype

do_block

process a named block.

Any other method of any other object can call this method. This is called 'public' access.

The data-type returned is "booltype"; Not sure.

The method takes the following arguments:

block : stringtype

The name of the block.

Here is a list of all overrides of this method inside sub-classes. Click on the object to take you to the definition.

• Overridden in tgl_block_parser : do_block
• Overridden in tgl_forlist_parser : do_block

get_block

Get the value of a named block.

Any other method of any other object can call this method. This is called 'public' access.

The data-type returned is "stringtype"; The value of the block.

The method takes the following arguments:

block : stringtype

The name of the block.

Here is a list of all overrides of this method inside sub-classes. Click on the object to take you to the definition.

• Overridden in tgl_block_parser : get_block
• Overridden in tgl_forlist_parser : get_block