Table of Contents

General stuff

• ach function takes in a pointer to a datablock of the dictionary.

Packages

• BlockNode::::Constructors:
• List:::: All of the following are modified a bit to deal with the myCurrent() index, but to the outside world they look like the normal vector operations:
• List:::: All of the following work exactly as they do in the regular STL vector class:
• LoopNameListNode:::: The following functions are all designed to make sure things stay correct within the STAR file rules.
• LoopNameListNode::::These are for use with STL iterator algorithms: The following allows the caller to use LoopNameListNode like it was an STL vector, with the extra stipulation that deletion or insertion operations will automatically cause the values in the same loop to be altered so that the loop is still valid STAR syntax.
• LoopRowNode::::

   	  *-------------------------------------------------- 	  * insert() and erase()    * 	  *-------------------------------------------------- 	  * The following functions will only work if this LoopRowNode has not 	  * yet been attached to a loop in a STAR tree.
  LoopRowNode::::These types are for use with the STL vector-like methods of this class
  LoopTableNode:::: Insertions/Deletions.
  LoopTableNode::::These types are used with the STL vector look-alike functions:
  StarListNode:::: THESE FOLLOWING METHODS ARE DEPRECIATED - use STL vector operations on the list returned by GiveMyDataBlockList instead
  
  

Classes

• ASTlist The purpose of this type is to be a template class just like the base "List" is, but with the added caveat that it works on ASTnodes that are part of an AST star file tree.
• ASTnode ASTnode class (base class for all other kinds of nodes).
• ASTnodeWithPosBits This is used internally by those AST nodes which have line number and column information.
• BlockNode A single block in the file - this can be either a data block or a global block - they are both handled the same way
• DVNWithPos This is identical to DataValueNode, but with one exception.
• DataBlockNode A data block of the form data_
• DataHeadingNode Contains nothing more than the name "data_" - this class exists more for orthagonoality more than utility
• DataItemNode Holds a single tag name / tag value pair
• DataListNode Holds a list of the kinds of things that can be in a DataBlockNode.
• DataLoopNameListNode This is a list of lists of names in a loop. The first list of names is the list of names for the outermost loop. the second list of names is the list of names for the next nesting level in, and so on.
• DataLoopNode A DataLoopNode is a list of tagnames and a list of values for those names.
• DataNameNode Holds a name of either a tag/value pair or a loop tag name
• DataNode classes: DataItemNode, DataLoopNode, or SaveFrameNode
• DataValueNode This is the type that holds a single string value from the star file, and the delimiter type that is used to quote it
• GlobalBlockNode A BlockNode speficly for holding the "global_" block
• GlobalHeadingNode Contains nothing more than the name "global_" - this class exists more for orthagonoality more than utility
• HeadingNode HeadingNode is a type that holds a simple header for one of the other types of nodes.
• List This is the generic list class that everything else is built on top of.
• LoopNameListNode A list of tag names representing one single nesting level of a loop's definition.
• LoopRowNode This class is a single row of values in a loop.
• LoopTableNode A LoopTableNode is a table of rows in a DataLoopNode.
• LoopVals thing to do -- Steve
• SaveFrameListNode Contains the things that are inside of a saveframe
• SaveFrameNode This is a save frame from the STAR file
• SaveHeadingNode Contains nothing more than the name "save_" - this class exists more for orthagonoality more than utility
• StarFileNode
• StarFileNode The Mother Of All Star Nodes (literally).
• StarListNode This class holds a list of the nodes that can be inside a star file.

Functions

• ASTnode::::getColNum
• ASTnode::::getLineNum
• ASTnode::::getPreComment
• ASTnode::::myParallelCopy
• searchByTagValue:
  • ASTnode::::searchByTagValue Given a tag name and a value, find the AST object that that particular tag and value pair resides in.
  • ASTnode::::searchByTagValue Overloaded Version Just calls the above version of this function.
  • ASTnode::::searchByTagValue Overloaded Version Just calls the above version of this function.
  • ASTnode::::searchByTagValue Overloaded Version Just calls the above version of this function.
• searchForTypeByTag:
  • ASTnode::::searchForTypeByTag Overloaded Version
  • ASTnode::::searchForTypeByTag Overloaded Version
• searchForTypeByTagValue:
  • ASTnode::::searchForTypeByTagValue Overloaded Version
  • ASTnode::::searchForTypeByTagValue Overloaded Version Just calls the above version of this function.
  • ASTnode::::searchForTypeByTagValue Overloaded Version Just calls the above version of this function.
  • ASTnode::::searchForTypeByTagValue Overloaded Version Just calls the above version of this function.
• ASTnode::::setColNum
• ASTnode::::setLineNum
• ASTnode::::setPeer
• ASTnode::::setPreComment
• BlockNode:
  • BlockNode::::BlockNode give the name to call the block
  • BlockNode::::BlockNode deep copy constructor
  • BlockNode::::BlockNode for more details on parallel copies
• DataBlockNode:
  • DataBlockNode::::DataBlockNode Copy constructor - parallel version:
  • DataBlockNode::::DataBlockNode
  • DataBlockNode::::DataBlockNode Copy constructor:
  • DataBlockNode::::DataBlockNode
• DataItemNode:
  • DataItemNode::::DataItemNode Make a new item given the name and value.
  • DataItemNode::::DataItemNode Make a new item given the name and value as strings.
  • DataItemNode::::DataItemNode Make a new item given the name and value and delimiter type.
  • DataItemNode::::DataItemNode Copy Constructor.
  • DataItemNode::::DataItemNode Copy with parallel link.
• setName:
  • DataItemNode::::setName
  • DataItemNode::::setName
• setValue:
  • DataItemNode::::setValue
  • DataItemNode::::setValue
• DataListNode:
  • DataListNode::::DataListNode Recursive deep copy - use this for most copying needs
  • DataListNode::::DataListNode Shallow dumb copy - don't use this unless you really know the insides of the library well
  • DataListNode::::DataListNode Make an empty list
  • DataListNode::::DataListNode Copy with parallel link.
• DataLoopNameListNode:
  • DataLoopNameListNode::::DataLoopNameListNode
  • DataLoopNameListNode::::DataLoopNameListNode Copy constructor with a deep recursive copy
  • DataLoopNameListNode::::DataLoopNameListNode Parallel copy constructor:
  • DataLoopNameListNode::::DataLoopNameListNode Also a Copy Constructor
  • DataLoopNameListNode::::DataLoopNameListNode Create an empty list of lists of names
• DataLoopNode:
  • DataLoopNode::::DataLoopNode
  • DataLoopNode::::DataLoopNode
  • DataLoopNode::::DataLoopNode
  • DataLoopNode::::DataLoopNode Copy Constructor
  • DataLoopNode::::DataLoopNode Copy with parallel link.
• DataLoopNode::::getIndentFlag
• DataLoopNode::::getRowsPerLine
• DataLoopNode::::getTabFlag
• DataLoopNode::::setIndentFlag
• DataLoopNode::::setRowsPerLine
• DataLoopNode::::setTabFlag
• DataLoopNode::getVals returns a reference or pointer to the LoopTableNode inside this DataValueNode.::getNames
• DataLoopNode::getVals returns a reference or pointer to the LoopTableNode inside this DataValueNode.::getNamesPtr
• setValue:
  • DataValueNode::::setValue
  • DataValueNode::::setValue
• FindNeededQuoteStyle either (") or (') or (;) or a space for 'none'
• GlobalBlockNode:
  • GlobalBlockNode::::GlobalBlockNode Copy constructor - parallel version:
  • GlobalBlockNode::::GlobalBlockNode
  • GlobalBlockNode::::GlobalBlockNode Copy constructor:
• InsertNeededQuoteStyle no change was made
• back:
  • List::::back
  • List::::back
• List::::begin
• List::::capacity
• List::::empty
• end:
  • List::::end
  • List::::end
• erase:
  • List::::erase
  • List::::erase
• front:
  • List::::front
  • List::::front
• insert:
  • List::::insert
  • List::::insert
• operator[]:
  • List::::operator[]
  • List::::operator[]
• List::::rbegin
• List::::rend
• List::::reserve
• List::::size
• LoopNameListNode:
  • LoopNameListNode::::LoopNameListNode Makes an empty list:
  • LoopNameListNode::::LoopNameListNode Deep-Copy Constructor
  • LoopNameListNode::::LoopNameListNode Copy with parallel link.
  • LoopNameListNode::::LoopNameListNode
  • LoopNameListNode::::LoopNameListNode
• back:
  • LoopNameListNode::::back
  • LoopNameListNode::::back
• LoopNameListNode::::begin
• LoopNameListNode::::empty
• end:
  • LoopNameListNode::::end
  • LoopNameListNode::::end
• erase:
  • LoopNameListNode::::erase erase - Remove the value given
  • LoopNameListNode::::erase erase - Remove the values in the range given as [from,to)
• front:
  • LoopNameListNode::::front
  • LoopNameListNode::::front
• insert:
  • LoopNameListNode::::insert This version makes a link to the DataNameNode in the list: (Don't delete the DataNameNode after you call this):
  • LoopNameListNode::::insert This version allows the caller to specify the value to insert:
  • LoopNameListNode::::insert This version allows the caller to specify the value to insert:
• operator[]:
  • LoopNameListNode::::operator[]
  • LoopNameListNode::::operator[]
• LoopNameListNode::::size
• LoopRowNode:
  • LoopRowNode::::LoopRowNode
  • LoopRowNode::::LoopRowNode
  • LoopRowNode::::LoopRowNode Copy Constructor
  • LoopRowNode::::LoopRowNode Copy with parallel link.
  • LoopRowNode::::LoopRowNode Make a new Iternode with the values given in the vector.
• erase:
  • LoopRowNode::::erase erase - Remove the value given
  • LoopRowNode::::erase erase - Remove the range of values given as [from,to)
• LoopRowNode::::getTabFlag
• LoopRowNode::::insert Make a link to the node given: (so don't delete it):
• LoopRowNode::::setTabFlag
• LoopTableNode:
  • LoopTableNode::::LoopTableNode
  • LoopTableNode::::LoopTableNode call with tflag = true for "tabulate" or false for "linear"
  • LoopTableNode::::LoopTableNode Copy Constructor
  • LoopTableNode::::LoopTableNode Copy with parallel link.
• erase:
  • LoopTableNode::::erase erase - Remove the range of rows given, using typical STL range conventions: The range is inclusive of the start, but exclusive of the end: [from,to)
  • LoopTableNode::::erase erase - Remove the row (LoopRowNode) given.
• LoopTableNode::::getIndentFlag
• LoopTableNode::::getRowsPerLine
• LoopTableNode::::getTabFlag
• insert:
  • LoopTableNode::::insert

     	  * Insert - Insert before 'pos', the LoopRowNode given.
    LoopTableNode::::insert This version makes a link to the node given, so don't delete it afterword:  (You are "giving" the new node to the class after having allocated it yourself)
    LoopTableNode::::insert 
     	  * Insert - Insert before 'pos', the table of data given 	  *            by the LoopTableNode.
    LoopTableNode::::insert This version makes a shallow link instead of a deep copy, so do not delete the node after passing it.
    

• LoopTableNode::::setIndentFlag
• LoopTableNode::::setRowsPerLine
• LoopTableNode::::setTabFlag
• SaveFrameListNode:
  • SaveFrameListNode::::SaveFrameListNode Make an empty list:
  • SaveFrameListNode::::SaveFrameListNode
  • SaveFrameListNode::::SaveFrameListNode for more details on parallel copies
  • SaveFrameListNode::::SaveFrameListNode Copy Constructor
• SaveFrameNode:
  • SaveFrameNode::::SaveFrameNode
  • SaveFrameNode::::SaveFrameNode Make a new empty save frame with the given name
  • SaveFrameNode:
    • SaveFrameNode Copy with parallel link.
    • SaveFrameNode Copy constructor
• SplitStringByWidth
• StarFileNode:
  • StarFileNode::::StarFileNode Copy with parallel link.
  • StarFileNode::::StarFileNode Make a copy of the star file tree (recurses down)
  • StarFileNode::::StarFileNode Make a trivial shallow copy
  • StarFileNode::::StarFileNode Make an empty star file tree:
• StarListNode::::AddDataBlock DEPRECIATED
• StarListNode::::AddSaveFrame DEPRECIATED
• StarListNode::::AddSaveFrameDataItem DEPRECIATED
• StarListNode::::AddSaveFrameLoop DEPRECIATED
• StarListNode::::AddSaveFrameLoopDataName DEPRECIATED
• StarListNode::::AddSaveFrameLoopDataValue DEPRECIATED
• StarListNode::::AddSaveFrameToDataBlock DEPRECIATED
• StarListNode::::RemoveSaveFrame DEPRECIATED
• StarListNode:
  • StarListNode::::StarListNode Recursive deep-copy constructor
  • StarListNode::::StarListNode Copy with parallel link.
  • StarListNode::::StarListNode Dumb shallow copy constructor - don't use unless you really understand the Star library well
  • StarListNode::::StarListNode Make an empty list:
• convertToFramecode a "$" to the string)
• deSpacify Returns the string with whitespace turned into underscores
• formatNMRSTAR This function formats the file according to the format defined in the formatTree passed in (which is a text file defining the commenting and loop spacing format for parts of the star file).
• parser_error scanner warning fn
• removeFirstChar of the string
• save_all_tag_to_scope This function does transformation 2
• save_keyed_renamed_tags This function does transformation 1c).
• save_keyed_tag_to_value This function does transformation 3c)
• save_loops This function does re-order transform II-2
• save_order This function does re-order transform II-1
• save_renamed_tags This function does transformation 1a).
• save_tag_to_framecode This function does transformation 1b).
• save_tag_to_value This function does transformation 3a)
• save_value_to_loop This function does transformation 3b)
• scanner_error
• scanner_warning scanner error fn
• strCmpInsensitive Performs a case-insensitive string compare
  Behaves like the standard C strcmp() function, returning -1 for less than, 0 for equals, and +1 for greater than
• tagToVal from the strings
• yyerror the parse function
• yylex the file from which the scanner reads
• yyparse

Variables

• AST
• ASTemptyString

    *     RCS HISTORY:  *   History:  * $Log: index.html,v $
  ASTemptyString  
    *     RCS HISTORY:  *   History:  * Revision 1.1.1.1  2005/10/11 22:15:22  web
  ASTemptyString  
    *     RCS HISTORY:  *   History:  * initial import
  ASTemptyString  
    *     RCS HISTORY:  *   History:  *
  ASTemptyString  
    *     RCS HISTORY:  *   History:  * Revision 1.6  2002/05/13 22:16:46  web
  ASTemptyString  
    *     RCS HISTORY:  *   History:  * Grrr..
  ASTemptyString  
    *     RCS HISTORY:  *   History:  *  * Revision 23  1999/11/19 02:04:58  informix  * No actual code changes  - cosmetic whitespace changes.
  ASTlist:::: The following functions are identical to their equivilent functions in List<>, but they have been changed to ensure that the newly added ASTnodes will have the proper parent pointer copied to them.
  ASTnode::::These functions are used to give each node in the AST tree the ability to remember a comment to be pasted into the file in front of that node.
  ASTnode::::These functions return the column number and set the column number on which this node was found in the STAR file.
  ASTnode::::These functions return the line number and set the line number on which this node was found in the STAR file.
  ASTnode::::This method is exactly like 'searchByTag()', except that it tries to return an object of the type given.
  ASTnode::::This method is exactly the same as 'searchByTag()', except that it tries to return an object of the type given.
  ASTnode::::This method returns a pointer to an ASTnode.
  DIC
  DataItemNode:::: Sets the string value of this node.
  DataItemNode::::Both these functions set the name of the tag.
  DataLoopNode::::Sets (or gets) the number of loop iterations to print on one line of text when unparsing.
  DataLoopNode::::Sets (or gets) the value of the tab flag for this loop.
  DataLoopNode::::sets or gets the indention flag for the loop.
  DataLoopNode::getVals returns a reference or pointer to the LoopTableNode inside this DataValueNode.::getNames returns a reference or pointer to the DataLoopNameListNode inside this DataValueNode.
  DataValueNode::::Changes the value of this string.
  LoopRowNode::::Sets (or gets) the tabulation flag for this row, and all nested loops inside it.
  LoopTableNode::::Sets (or gets) the boolean flag for whether or not to indent the values in this loop.
  LoopTableNode::::Sets (or gets) the number of loop iterations to print on one line of text when unparsing.
  LoopTableNode::::Sets (or gets) the tabulation flag for this loop, and all nested loops inside it.
  NMR
  errStream
  starErrReport The collection of all the error messages that were built up in the parsing.
  yyin
  

Macros

• ARCH_DEFINED
• DataLoopDefListNode Depreciated name for DataLoopNameListNode for backward compatability:
• IterNode DEPRECIATED name for LoopRowNode for backward compatability:
• LoopDefListNode DEPRECIATED name for LoopNameListNode for backward compatability:

Enums, Unions, Structs

• StarErrEntry The struct that holds a single error message from the parser:
• StarErrID The ID number for the kinds of errors there are:
• TokenType The type of the value associated with each token

Typedefs

• DataLoopNameListNode::::*value_type
• DataLoopNameListNode::::const_pointer
• DataLoopNameListNode::::const_reference
• DataLoopNameListNode::::difference_type
• DataLoopNameListNode::::pointer
• DataLoopNameListNode::::reference
• DataLoopNameListNode::::size_type
• LoopNameListNode::::*value_type
• LoopNameListNode::::const_pointer
• LoopNameListNode::::const_reference
• LoopNameListNode::::difference_type
• LoopNameListNode::::pointer
• LoopNameListNode::::reference
• LoopNameListNode::::size_type
• LoopRowNode::::const_pointer
• LoopRowNode::::const_reference
• LoopRowNode::::difference_type
• LoopRowNode::::pointer
• LoopRowNode::::reference
• LoopRowNode::::size_type
• LoopTableNode::::const_pointer
• LoopTableNode::::const_reference
• LoopTableNode::::difference_type
• LoopTableNode::::pointer
• LoopTableNode::::reference
• LoopTableNode::::size_type
• This struct is used internally to save some space in each node.

Hierarchy of classes

---

Starlib is a creation of BioMagResBank: bmrb.wisc.edu