Up

AGSHtml... a class to output html for a gsdoc file

Authors

Richard Frith-Macdonald (richard@brainstorm.co.uk)

Copyright: (C) 2001 Free Software Foundation, Inc.

Software documentation for the AGSHtml class

AGSHtml : NSObject

Declared in:
AGSHtml.h
Standards:

Description forthcoming.


Instance Variables

Method summary

decIndent 

- (void) decIndent;

Description forthcoming.


incIndent 

- (void) incIndent;

Description forthcoming.


makeAnchor: ofType: name: 

- (NSString*) makeAnchor: (NSString*)r ofType: (NSString*)t name: (NSString*)n;

Calls -makeLink:ofType:isRef: or -makeLink:ofType:inUnit:isRef: to create the first part of an anchor, and fills in the text content of the anchor with n (the specified name). Returns an entire anchor string as a result.
This method is used to create all the anchors in the html output.


makeLink: ofType: inUnit: isRef: 

- (NSString*) makeLink: (NSString*)r ofType: (NSString*)t inUnit: (NSString*)u isRef: (BOOL)f;

Make a link for the element r, with the specified type t, in a particular unit u. Only the start of the html element is returned (<a...>).
If the boolean f is YES, then the link is a reference to somewhere, otherwise the link is an anchor for some element being output.
If there is an error, the method returns nil.


makeLink: ofType: isRef: 

- (NSString*) makeLink: (NSString*)r ofType: (NSString*)t isRef: (BOOL)f;

Make a link for the element r with the specified type. Only the start of the html element is returned (<a...>). If the boolean f is YES, then the link is a reference to somewhere, and the method will return nil if the destination is not found in the index. If f is NO, then the link is an anchor for some element being output, and the method is guaranteed to succeed and return the link.


outputBlock: to: inPara: 

- (GSXMLNode*) outputBlock: (GSXMLNode*)node to: (NSMutableString*)buf inPara: (BOOL)flag;

Outputs zero or more nodes at the same level as long as the nodes are valid %block elements. Returns nil or the first node not output. The value of flag is used to control paragraph nesting... if YES we close a paragraph before opening a new one, and open again once the new paragraph closes.


outputDocument: 

- (NSString*) outputDocument: (GSXMLNode*)node;

Description forthcoming.


outputIndex: scope: title: style: target: to: 

- (void) outputIndex: (NSString*)type scope: (NSString*)scope title: (NSString*)title style: (NSString*)style target: (NSString*)target to: (NSMutableString*)buf;

Description forthcoming.


outputList: to: 

- (GSXMLNode*) outputList: (GSXMLNode*)node to: (NSMutableString*)buf;

Outputs a node as long as it is a valid %list element. Returns next node at this level.


outputNode: to: 

- (void) outputNode: (GSXMLNode*)node to: (NSMutableString*)buf;

As a special case, if we have a reference to a function, and we can't find it, we check to see if there is actually a macro of that name and refer to that instead.


outputNodeList: to: 

- (void) outputNodeList: (GSXMLNode*)node to: (NSMutableString*)buf;

Output all the nodes from this one onwards... try to output as text first, if not possible, call the main method to output each node.


outputText: to: 

- (GSXMLNode*) outputText: (GSXMLNode*)node to: (NSMutableString*)buf;

Outputs zero or more nodes at the same level as long as the nodes are valid %text elements. Returns nil or the first node not output.


outputUnit: to: 

- (void) outputUnit: (GSXMLNode*)node to: (NSMutableString*)buf;

Description forthcoming.


protocolRef: 

- (NSString*) protocolRef: (NSString*)t;

Try to make a link to the documentation for the supplied protocol.


setGlobalRefs: 

- (void) setGlobalRefs: (AGSIndex*)r;

Description forthcoming.


setInstanceVariablesAtEnd: 

- (void) setInstanceVariablesAtEnd: (BOOL)val;

Description forthcoming.


setLocalRefs: 

- (void) setLocalRefs: (AGSIndex*)r;

Description forthcoming.


setProjectRefs: 

- (void) setProjectRefs: (AGSIndex*)r;

Description forthcoming.


typeRef: 

- (NSString*) typeRef: (NSString*)t;

Assuming that the supplied string contains type information (as used in a method declaration or type cast), we make an attempt at extracting the basic type, and seeing if we can find a documented declaration for it. If we can, we return a modified version of the string containing a link to the appropriate documentation. Otherwise, we just return the plain type string. In all cases, we strip leading and trailing white space.




Instance Variables for AGSHtml Class

base

@protected NSString* base;

Description forthcoming.


category

@protected NSString* category;

Description forthcoming.


chap

@protected unsigned int chap;

Description forthcoming.


classname

@protected NSString* classname;

Description forthcoming.


globalRefs

@protected AGSIndex* globalRefs;

Description forthcoming.


heading

@protected NSString* heading;

Description forthcoming.


indent

@protected NSMutableString* indent;

Description forthcoming.


isContentsDoc

@protected BOOL isContentsDoc;

Description forthcoming.


ivarsAtEnd

@protected BOOL ivarsAtEnd;

Description forthcoming.


localRefs

@protected AGSIndex* localRefs;

Description forthcoming.


nextFile

@protected NSString* nextFile;

Description forthcoming.


prevFile

@protected NSString* prevFile;

Description forthcoming.


projectRefs

@protected AGSIndex* projectRefs;

Description forthcoming.


sect

@protected unsigned int sect;

Description forthcoming.


ssect

@protected unsigned int ssect;

Description forthcoming.


sssect

@protected unsigned int sssect;

Description forthcoming.


unit

@protected NSString* unit;

Description forthcoming.


upFile

@protected NSString* upFile;

Description forthcoming.






Up