\n"];
[self incIndent];
[self outputBlock: children to: buf inPara: YES];
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
}
else if ([name isEqual: @"em"] == YES)
{
[buf appendString: @"\n"];
[self incIndent];
[self outputNodeList: children to: buf];
// Close front division
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
}
else if ([name isEqual: @"gsdoc"] == YES)
{
base = [prop objectForKey: @"base"];
if (base == nil)
{
NSLog(@"No 'base' document name supplied in gsdoc element");
return;
}
nextFile = [prop objectForKey: @"next"];
nextFile = [nextFile stringByAppendingPathExtension: @"html"];
prevFile = [prop objectForKey: @"pref"];
prevFile = [prevFile stringByAppendingPathExtension: @"html"];
upFile = [prop objectForKey: @"up"];
upFile = [upFile stringByAppendingPathExtension: @"html"];
[self outputNodeList: children to: buf];
}
else if ([name isEqual: @"head"] == YES)
{
[buf appendString: indent];
[buf appendString: @"\n"];
[self incIndent];
[buf appendString: indent];
[buf appendString: @""];
[self outputText: [children children] to: buf];
[buf appendString: @"
\n"];
[buf appendString: indent];
[buf appendString: @"Authors
\n"];
[buf appendString: indent];
[buf appendString: @"\n"];
[self incIndent];
children = firstElement([children next]);
while ([[children name] isEqual: @"author"] == YES)
{
GSXMLNode *author = children;
GSXMLNode *tmp;
GSXMLNode *email = nil;
GSXMLNode *url = nil;
GSXMLNode *desc = nil;
children = [children next];
children = firstElement(children);
tmp = firstElement([author children]);
if ([[tmp name] isEqual: @"email"] == YES)
{
email = tmp;
tmp = firstElement([tmp next]);
}
if ([[tmp name] isEqual: @"url"] == YES)
{
url = tmp;
tmp = firstElement([tmp next]);
}
if ([[tmp name] isEqual: @"desc"] == YES)
{
desc = tmp;
tmp = firstElement([tmp next]);
}
[buf appendString: indent];
if (url == nil)
{
[buf appendString: @"- "];
[buf appendString: [[author propertiesAsDictionary]
objectForKey: @"name"]];
}
else
{
[buf appendString: @"
- "];
[buf appendString: [[author propertiesAsDictionary]
objectForKey: @"name"]];
[buf appendString: @""];
}
if (email != nil)
{
[buf appendString: @"("];
[self outputNode: email to: buf];
[buf appendString: @")"];
}
[buf appendString: @"
\n"];
[buf appendString: indent];
[buf appendString: @" - \n"];
if (desc != nil)
{
[self incIndent];
[self outputBlock: desc to: buf inPara: NO];
[self decIndent];
}
[buf appendString: indent];
[buf appendString: @"
\n"];
}
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
if ([[children name] isEqual: @"version"] == YES)
{
[buf appendString: indent];
[buf appendString: @"Version: "];
[self outputNode: [children children] to: buf];
[buf appendString: @"
\n"];
children = firstElement([children next]);
}
if ([[children name] isEqual: @"date"] == YES)
{
[buf appendString: indent];
[buf appendString: @"Date: "];
[self outputNode: [children children] to: buf];
[buf appendString: @"
\n"];
children = firstElement([children next]);
}
if ([[children name] isEqual: @"abstract"] == YES)
{
[buf appendString: indent];
[buf appendString: @"\n"];
[self incIndent];
[self outputBlock: [children children] to: buf inPara: NO];
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
children = firstElement([children next]);
}
if ([[children name] isEqual: @"copy"] == YES)
{
[buf appendString: indent];
[buf appendString: @"Copyright: "];
[self outputNode: [children children] to: buf];
[buf appendString: @"
\n"];
children = firstElement([children next]);
}
}
else if ([name isEqual: @"heading"] == YES)
{
[buf appendString: indent];
[buf appendString: @"<"];
[buf appendString: heading];
[buf appendString: @">"];
[self outputText: children to: buf];
[buf appendString: @"\n"];
}
else if ([name isEqual: @"ivariable"] == YES)
{
NSString *tmp = [prop objectForKey: @"name"];
NSLog(@"Element '%@' not implemented", name); // FIXME
}
else if ([name isEqual: @"label"] == YES) // %anchor
{
NSString *text;
NSString *val;
text = [children content];
val = [prop objectForKey: @"id"];
if (val == nil)
{
val = text;
}
[buf appendFormat: @"", val];
[self outputText: children to: buf];
[buf appendString: @""];
}
else if ([name isEqual: @"method"] == YES)
{
NSString *sel;
NSString *str;
GSXMLNode *tmp = children;
BOOL hadArg = NO;
sel = [prop objectForKey: @"factory"];
str = [prop objectForKey: @"type"];
if (sel != nil && [sel boolValue] == YES)
{
sel = @"+";
str = [NSString stringWithFormat: @"+ (%@) ",
[self typeRef: str]];
}
else
{
sel = @"-";
str = [NSString stringWithFormat: @"- (%@) ",
[self typeRef: str]];
}
children = nil;
while (tmp != nil)
{
if ([tmp type] == XML_ELEMENT_NODE)
{
if ([[tmp name] isEqual: @"sel"] == YES)
{
GSXMLNode *t = [tmp children];
str = [str stringByAppendingString: @""];
while (t != nil)
{
if ([t type] == XML_TEXT_NODE)
{
NSString *content = [t content];
sel = [sel stringByAppendingString: content];
if (hadArg == YES)
{
str = [str stringByAppendingString: @" "];
}
str = [str stringByAppendingString: content];
}
t = [t next];
}
str = [str stringByAppendingString: @""];
}
else if ([[tmp name] isEqual: @"arg"] == YES)
{
GSXMLNode *t = [tmp children];
NSString *s;
s = [[tmp propertiesAsDictionary] objectForKey: @"type"];
s = [self typeRef: s];
str = [str stringByAppendingFormat: @" (%@)", s];
while (t != nil)
{
if ([t type] == XML_TEXT_NODE)
{
str = [str stringByAppendingString: [t content]];
}
t = [t next];
}
hadArg = YES; // Say we have found an arg.
}
else if ([[tmp name] isEqual: @"vararg"] == YES)
{
sel = [sel stringByAppendingString: @",..."];
str = [str stringByAppendingString: @",..."];
children = [tmp next];
break;
}
else
{
children = tmp;
break;
}
}
tmp = [tmp next];
}
if ([sel length] > 1)
{
/*
* Output selector heading.
*/
[buf appendString: indent];
[buf appendFormat: @"\n",
unit, sel, [sel substringFromIndex: 1]];
[buf appendString: indent];
[buf appendString: str];
[buf appendString: @";
\n"];
node = children;
/*
* List standards with which method complies
*/
children = [node next];
if ([[children name] isEqual: @"standards"])
{
tmp = [node children];
if (tmp != nil)
{
[buf appendString: @"Standards:"];
while (tmp != nil)
{
[buf appendString: @" "];
[buf appendString: [tmp name]];
tmp = [tmp next];
}
[buf appendString: @"
\n"];
}
}
if ((str = [prop objectForKey: @"init"]) != nil
&& [str boolValue] == YES)
{
[buf appendString: @"This is a designated initialiser "
@"for the class.
\n"];
}
str = [prop objectForKey: @"override"];
if ([str isEqual: @"subclass"] == YES)
{
[buf appendString: @"Subclasses should "
@"override this method.
\n"];
}
else if ([str isEqual: @"never"] == YES)
{
[buf appendString: @"Subclasses should NOT "
@"override this method.
\n"];
}
if ([[node name] isEqual: @"desc"])
{
[self outputNode: node to: buf];
}
[buf appendString: indent];
[buf appendString: @"
\n"];
}
}
else if ([name isEqual: @"p"] == YES)
{
[self outputBlock: node to: buf inPara: NO];
}
else if ([name isEqual: @"prjref"] == YES)
{
NSLog(@"Element '%@' not implemented", name); // FIXME
}
else if ([name isEqual: @"ref"] == YES) // %xref
{
NSString *type = [prop objectForKey: @"type"];
NSString *r = [prop objectForKey: @"id"];
NSString *f = nil;
BOOL isLocal = YES;
if ([type isEqual: @"method"] || [type isEqual: @"variable"])
{
NSString *c = [prop objectForKey: @"class"];
/*
* No class specified ... try to infer it.
*/
if (c == nil)
{
/*
* If we are currently inside a class, category, or protocol
* we see if the required item exists in that unit and if so,
* we assume that we need a local reference.
*/
if (unit != nil)
{
f = [localRefs unitRef: r type: type unit: unit];
if (f == nil)
{
f = [globalRefs unitRef: r type: type unit: unit];
if (f != nil)
{
isLocal = NO;
c = unit;
}
}
else
{
c = unit;
}
}
/*
* If we have not found it in the current unit, we check
* all known references to see if the item is uniquely
* documented somewhere.
*/
if (c == nil)
{
NSDictionary *d;
d = [localRefs unitRef: r type: type];
if ([d count] == 0)
{
isLocal = NO;
d = [globalRefs unitRef: r type: type];
}
if ([d count] == 1)
{
/*
* Record the class where the item is documented
* and the file where that documentation occurs.
*/
c = [[d allKeys] objectAtIndex: 0];
f = [d objectForKey: c];
}
}
}
else
{
/*
* Simply look up the reference.
*/
f = [localRefs unitRef: r type: type unit: c];
if (f == nil)
{
isLocal = NO;
f = [globalRefs unitRef: r type: type unit: c];
}
}
if (f != nil)
{
f = [f stringByAppendingPathExtension: @"html"];
if (isLocal == YES)
{
[buf appendFormat: @"", c, r];
}
else
{
[buf appendFormat: @"", f, c, r];
}
}
}
else
{
f = [localRefs globalRef: r type: type];
if (f == nil)
{
isLocal = NO;
f = [globalRefs globalRef: r type: type];
}
if (f != nil)
{
f = [f stringByAppendingPathExtension: @"html"];
if (isLocal == YES)
{
[buf appendFormat: @"", type, r];
}
else
{
[buf appendFormat: @"", f, type, r];
}
}
}
if (f == nil)
{
NSLog(@"ref '%@' not found for %@", r, type);
[self outputText: [node children] to: buf];
}
else
{
[self outputText: [node children] to: buf];
[buf appendString: @"\n"];
}
}
else if ([name isEqual: @"protocol"] == YES)
{
NSString *name = [prop objectForKey: @"name"];
unit = [NSString stringWithFormat: @"(%@)", name];
[buf appendFormat:
@"\n", unit, name];
[self outputUnit: node to: buf];
unit = nil;
}
else if ([name isEqual: @"constant"] == YES
|| [name isEqual: @"EOEntity"] == YES
|| [name isEqual: @"EOModel"] == YES
|| [name isEqual: @"function"] == YES
|| [name isEqual: @"macro"] == YES
|| [name isEqual: @"type"] == YES
|| [name isEqual: @"variable"] == YES)
{
NSString *tmp = [prop objectForKey: @"name"];
NSLog(@"Element '%@' not implemented", name); // FIXME
}
else if ([name isEqual: @"section"] == YES)
{
heading = @"h2";
[self outputNodeList: children to: buf];
}
else if ([name isEqual: @"site"] == YES)
{
[buf appendString: @""];
[self outputText: children to: buf];
[buf appendString: @""];
}
else if ([name isEqual: @"strong"] == YES)
{
[buf appendString: @""];
[self outputText: children to: buf];
[buf appendString: @""];
}
else if ([name isEqual: @"subsect"] == YES)
{
heading = @"h3";
[self outputNodeList: children to: buf];
}
else if ([name isEqual: @"subsubsect"] == YES)
{
heading = @"h4";
[self outputNodeList: children to: buf];
}
else if ([name isEqual: @"type"] == YES)
{
NSString *n = [prop objectForKey: @"name"];
node = [node children];
[buf appendString: indent];
[buf appendFormat: @"",
n, [node content], n];
node = [node next];
if (node != nil && [[node name] isEqual: @"declared"] == YES)
{
[buf appendString: indent];
[buf appendString: @"Declared: "];
[self outputText: [node children] to: buf];
[buf appendString: @"
\n"];
node = [node next];
}
if (node != nil && [[node name] isEqual: @"desc"] == YES)
{
[self outputNode: node to: buf];
node = [node next];
}
if (node != nil && [[node name] isEqual: @"standards"] == YES)
{
[self outputNode: node to: buf];
node = [node next];
}
}
else if ([name isEqual: @"uref"] == YES)
{
[buf appendString: @""];
[self outputText: children to: buf];
[buf appendString: @""];
}
else if ([name isEqual: @"url"] == YES)
{
NSLog(@"Element '%@' not implemented", name); // FIXME
}
else if ([name isEqual: @"var"] == YES) // %phrase
{
[buf appendString: @""];
[self outputText: children to: buf];
[buf appendString: @""];
}
else
{
GSXMLNode *tmp;
/*
* Try outputing as any of the list elements.
*/
tmp = [self outputList: node to: buf];
if (tmp == node)
{
NSLog(@"Element '%@' not implemented", name); // FIXME
}
node = tmp;
}
}
RELEASE(arp);
}
- (void) outputNodeList: (GSXMLNode*)node to: (NSMutableString*)buf
{
while (node != nil)
{
GSXMLNode *next = [node next];
[self outputNode: node to: buf];
node = next;
}
}
/**
* 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.
*/
- (GSXMLNode*) outputBlock: (GSXMLNode*)node
to: (NSMutableString*)buf
inPara: (BOOL)flag
{
if (node != nil && [node type] == XML_ELEMENT_NODE)
{
GSXMLNode *tmp = node;
NSString *n;
node = [self outputList: node to: buf];
if (node != tmp)
{
return node;
}
n = [node name];
if ([n isEqual: @"p"] == YES)
{
if (flag == YES)
{
[self decIndent];
[buf appendString: indent];
[buf appendString: @"\n"];
}
[buf appendString: indent];
[buf appendString: @"\n"];
[self incIndent];
[self outputText: [node children] to: buf];
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
if (flag == YES)
{
[buf appendString: indent];
[buf appendString: @"\n"];
[self incIndent];
}
return [node next];
}
else if ([n isEqual: @"example"] == YES)
{
[buf appendString: @"\n
\n"];
[self outputText: [node children] to: buf];
[buf appendString: @"\n
\n"];
return [node next];
}
else if ([n isEqual: @"embed"] == YES)
{
NSLog(@"Element 'embed' not supported");
return [node next];
}
else
{
NSLog(@"Non-block element '%@' in block ...", n);
return node;
}
}
return [self outputText: node to: buf];
}
/**
* Outputs a node as long as it is a
* valid %list element. Returns next node at this level.
*/
- (GSXMLNode*) outputList: (GSXMLNode*)node to: (NSMutableString*)buf
{
NSString *name = [node name];
GSXMLNode *children = [node children];
if ([name isEqual: @"list"] == YES)
{
[buf appendString: indent];
[buf appendString: @"\n"];
[self incIndent];
while (children != nil)
{
[buf appendString: indent];
[buf appendString: @"- \n"];
[self incIndent];
[self outputBlock: [children children] to: buf inPara: NO];
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
children = [children next];
}
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
}
else if ([name isEqual: @"enum"] == YES)
{
[buf appendString: indent];
[buf appendString: @"\n"];
[self incIndent];
while (children != nil)
{
[buf appendString: indent];
[buf appendString: @"- \n"];
[self incIndent];
[self outputBlock: [children children] to: buf inPara: NO];
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
children = [children next];
}
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
}
else if ([name isEqual: @"deflist"] == YES)
{
[buf appendString: indent];
[buf appendString: @"\n"];
[self incIndent];
while (children != nil)
{
[buf appendString: indent];
[buf appendString: @"- "];
[self outputText: [children children] to: buf];
[buf appendString: @"
\n"];
children = [children next];
[buf appendString: indent];
[buf appendString: @"- \n"];
[self incIndent];
[self outputBlock: [children children] to: buf inPara: NO];
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
children = [children next];
}
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
}
else if ([name isEqual: @"qalist"] == YES)
{
[buf appendString: indent];
[buf appendString: @"\n"];
[self incIndent];
while (children != nil)
{
[buf appendString: indent];
[buf appendString: @"- "];
[self outputText: [children children] to: buf];
[buf appendString: @"
\n"];
children = [children next];
[buf appendString: indent];
[buf appendString: @"- \n"];
[self incIndent];
[self outputBlock: [children children] to: buf inPara: NO];
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
children = [children next];
}
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
}
else if ([name isEqual: @"dictionary"] == YES)
{
NSLog(@"Element '%@' not implemented", name); // FIXME
}
else
{
return node; // Not a list
}
node = [node next];
return node;
}
/**
* 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.
*/
- (GSXMLNode*) outputText: (GSXMLNode*)node to: (NSMutableString*)buf
{
while (node != nil)
{
if ([node type] == XML_TEXT_NODE)
{
[buf appendString: [node content]];
}
else if ([node type] == XML_ENTITY_REF_NODE)
{
[buf appendString: @"&"];
[buf appendString: [node name]];
[buf appendString: @";"];
}
else if ([node type] == XML_ELEMENT_NODE)
{
NSString *name = [node name];
if ([textNodes member: name] != nil)
{
[self outputNode: node to: buf];
}
else
{
return node; // Not a text node.
}
}
node = [node next];
}
return node;
}
- (void) outputUnit: (GSXMLNode*)node to: (NSMutableString*)buf
{
node = [node children];
if (node != nil && [[node name] isEqual: @"declared"] == YES)
{
[buf appendString: indent];
[buf appendString: @"Declared: "];
[self outputText: [node children] to: buf];
[buf appendString: @"
\n"];
node = [node next];
}
while (node != nil && [[node name] isEqual: @"conform"] == YES)
{
NSString *text = [[node children] content];
[buf appendString: indent];
[buf appendString: @"Conform: "];
[buf appendString: [self protocolRef: text]];
[buf appendString: @"
\n"];
node = [node next];
}
if (node != nil && [[node name] isEqual: @"desc"] == YES)
{
[self outputNode: node to: buf];
node = [node next];
}
while (node != nil && [[node name] isEqual: @"method"] == YES)
{
[self outputNode: node to: buf];
node = [node next];
}
if (node != nil && [[node name] isEqual: @"standards"] == YES)
{
[self outputNode: node to: buf];
node = [node next];
}
}
/**
* Try to make a link to the documentation for the supplied protocol.
*/
- (NSString*) protocolRef: (NSString*)t
{
NSString *n;
NSString *s;
t = [t stringByTrimmingSpaces];
n = [NSString stringWithFormat: @"(%@)", t];
if ((s = [localRefs globalRef: n type: @"protocol"]) != nil)
{
t = [NSString stringWithFormat: @"%@", n, t];
}
else if ((s = [globalRefs globalRef: t type: @"protocol"]) != nil)
{
s = [s stringByAppendingPathExtension: @"html"];
t = [NSString stringWithFormat: @"%@",
s, n, t];
}
return t;
}
- (void) setGlobalRefs: (AGSIndex*)r
{
ASSIGN(globalRefs, r);
}
- (void) setLocalRefs: (AGSIndex*)r
{
ASSIGN(localRefs, r);
}
/**
* 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.
*/
- (NSString*) typeRef: (NSString*)t
{
NSString *orig = [t stringByTrimmingSpaces];
NSString *s;
unsigned end = [orig length];
unsigned start;
t = orig;
while (end > 0)
{
unichar c = [t characterAtIndex: end-1];
if (c != '*' && !isspace(c))
{
break;
}
end--;
}
start = end;
while (start > 0)
{
unichar c = [t characterAtIndex: start-1];
if (c != '_' && !isalnum(c))
{
break;
}
start--;
}
t = [orig substringWithRange: NSMakeRange(start, end - start)];
if ((s = [localRefs globalRef: t type: @"type"]) != nil)
{
s = [NSString stringWithFormat: @"%@", t, t];
}
else if ((s = [localRefs globalRef: t type: @"class"]) != nil)
{
s = [NSString stringWithFormat: @"%@", t, t];
}
else if ((s = [globalRefs globalRef: t type: @"type"]) != nil)
{
s = [s stringByAppendingPathExtension: @"html"];
s = [NSString stringWithFormat: @"%@",
s, t, t];
}
else if ((s = [globalRefs globalRef: t type: @"class"]) != nil)
{
s = [s stringByAppendingPathExtension: @"html"];
s = [NSString stringWithFormat: @"%@",
s, t, t];
}
if (s != nil)
{
if ([orig length] == [t length])
{
return s;
}
return [orig stringByReplacingString: t withString: s];
}
return orig;
}
@end