Up

GSWeb: Class GSWTemplateParser

Authors

Manuel Guesdon (mguesdon@orange-concept.com)

Version: 1.7

Date: 2004/03/25 08:35:25

Copyright: (C) 1999-2004 Free Software Foundation, Inc.

Contents -

  1. Software documentation for the GSWTemplateParser class
  2. Software documentation for the GSWTemplateParserDelegate protocol
  3. GSWTemplateParser types
  4. GSWTemplateParser functions

Software documentation for the GSWTemplateParser class

GSWTemplateParser : NSObject

Declared in:
Foundation/GSWTemplateParser.h
Conforms to:
GSWDeclarationParserPragmaDelegate
Standards:

Base template parser

Instance Variables

Method summary

defaultTemplateParserType 

+ (GSWTemplateParserType) defaultTemplateParserType;

Description forthcoming.

templateNamed: inFrameworkNamed: withParserType: parserClass: withString: encoding: fromPath: declarationsString: languages: declarationsPath: 

+ (GSWElement*) templateNamed: (NSString*)aName inFrameworkNamed: (NSString*)aFrameworkName withParserType: (GSWTemplateParserType)parserType parserClass: (Class)parserClass withString: (NSString*)HTMLString encoding: (NSStringEncoding)encoding fromPath: (NSString*)HTMLPath declarationsString: (NSString*)declarationsString languages: (NSArray*)someLanguages declarationsPath: (NSString*)aDeclarationsPath;

Description forthcoming.

templateNamed: inFrameworkNamed: withParserType: parserClassName: withString: encoding: fromPath: declarationsString: languages: declarationsPath: 

+ (GSWElement*) templateNamed: (NSString*)aName inFrameworkNamed: (NSString*)aFrameworkName withParserType: (GSWTemplateParserType)parserType parserClassName: (NSString*)parserClassName withString: (NSString*)HTMLString encoding: (NSStringEncoding)encoding fromPath: (NSString*)HTMLPath declarationsString: (NSString*)declarationsString languages: (NSArray*)someLanguages declarationsPath: (NSString*)aDeclarationsPath;

Description forthcoming.

templateParserTypeFromString: 

+ (GSWTemplateParserType) templateParserTypeFromString: (NSString*)string;

Description forthcoming.

addErrorMessage: 

- (void) addErrorMessage: (NSString*)errorMessage;

Description forthcoming.

addErrorMessageFormat: ,...

- (void) addErrorMessageFormat: (NSString*)format,...;

Description forthcoming.

addErrorMessageFormat: arguments: 

- (void) addErrorMessageFormat: (NSString*)format arguments: (va_list)arguments;

Description forthcoming.

declarations 

- (NSDictionary*) declarations;

Description forthcoming.

errorMessages 

- (NSMutableArray*) errorMessages;

Description forthcoming.

errorMessagesAsText 

- (NSString*) errorMessagesAsText;

Description forthcoming.

includedDeclarationsFromFilePath: fromFrameworkNamed: 

- (NSDictionary*) includedDeclarationsFromFilePath: (NSString*)file fromFrameworkNamed: (NSString*)frameworkName;

Description forthcoming.

initWithTemplateName: inFrameworkName: withString: encoding: fromPath: withDeclarationsString: fromPath: forLanguages: 

- (id) initWithTemplateName: (NSString*)aName inFrameworkName: (NSString*)aFrameworkName withString: (NSString*)HTMLString encoding: (NSStringEncoding)anEncoding fromPath: (NSString*)HTMLPath withDeclarationsString: (NSString*)declarationsString fromPath: (NSString*)aDeclarationsPath forLanguages: (NSArray*)someLanguages;

Description forthcoming.

logPrefix 

- (NSString*) logPrefix;

Description forthcoming.

parseDeclarations 

- (void) parseDeclarations;

Description forthcoming.

parseDeclarationsString: named: inFrameworkNamed: 

- (NSDictionary*) parseDeclarationsString: (NSString*)declarationsString named: (NSString*)declarationsName inFrameworkNamed: (NSString*)declarationsFrameworkName;

Description forthcoming.

template 

- (GSWElement*) template;

Description forthcoming.

templateElements 

- (NSArray*) templateElements;

Description forthcoming.


Instance Variables for GSWTemplateParser Class

_declarations

@protected NSDictionary* _declarations;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_declarationsFilePath

@protected NSString* _declarationsFilePath;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_declarationsString

@protected NSString* _declarationsString;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_errorMessages

@protected NSMutableArray* _errorMessages;

Template/declaration errors. If non empty, raise an exception
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_frameworkName

@protected NSString* _frameworkName;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_languages

@protected NSArray* _languages;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_processedDeclarationsFilePaths

@protected NSMutableSet* _processedDeclarationsFilePaths;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_string

@protected NSString* _string;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_stringEncoding

@protected NSStringEncoding _stringEncoding;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_stringPath

@protected NSString* _stringPath;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_template

@protected GSWElement* _template;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

_templateName

@protected NSString* _templateName;

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.

gswebTagN

@protected int gswebTagN;

Description forthcoming.

tagN

@protected int tagN;

Description forthcoming.



Software documentation for the GSWTemplateParserDelegate protocol

GSWTemplateParserDelegate

Declared in:
Foundation/GSWTemplateParser.h
Standards:

Template Parsing protocol for new parsers

Method summary

parser: didParseClosingDynamicTagOfType: withTemplateInfo: 

- (void) parser: (GSWBaseParser*)parser didParseClosingDynamicTagOfType: (GSWHTMLRawParserTagType)tagType withTemplateInfo: (NSString*)templateInfo;

Called by parser when it has closed a dynamic tag Creates a dynamic element from current temporary element element

parser: didParseComment: 

- (void) parser: (GSWBaseParser*)parser didParseComment: (NSString*)text;

Called by parser when it has parsed a comment Creates a GSWHTMLComment with the comment text

parser: didParseOpeningDynamicTagOfType: withProperties: templateInfo: 

- (void) parser: (GSWBaseParser*)parser didParseOpeningDynamicTagOfType: (GSWHTMLRawParserTagType)tagType withProperties: (NSDictionary*)tagProperties templateInfo: (NSString*)templateInfo;

Called by parser when it has opened a dynamic tag Creates a GSWTemporaryElement element, waiting for tag end

parser: didParseText: 

- (void) parser: (GSWBaseParser*)parser didParseText: (NSString*)text;

Called by parser when it has parsed raw text Creates a GSWHTMLBareString element with the text

GSWTemplateParser types

GSWHTMLRawParserTagType

typedef enum _GSWHTMLRawParserTagType GSWHTMLRawParserTagType;

Description forthcoming.

GSWTemplateParserType

typedef enum _GSWTemplateParserType GSWTemplateParserType;

Description forthcoming.

GSWTemplateParser functions

_parserIsCommentTagType

BOOL _parserIsCommentTagType(GSWHTMLRawParserTagType tagType);

Description forthcoming.

_parserIsDynamicOrCommentTagType

BOOL _parserIsDynamicOrCommentTagType(GSWHTMLRawParserTagType tagType);

Description forthcoming.

_parserIsDynamicTagType

BOOL _parserIsDynamicTagType(GSWHTMLRawParserTagType tagType);

Description forthcoming.


Up