\n"];
[self incIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
[self incIndent];
}
if (prevFile != nil)
{
[buf appendString: indent];
[buf appendFormat: @"
Prev\n", prevFile];
}
if (upFile != nil)
{
[buf appendString: indent];
[buf appendFormat: @"
Up\n", upFile];
}
if (nextFile != nil)
{
[buf appendString: indent];
[buf appendFormat: @"
Next\n", nextFile];
}
if (prevFile != nil || upFile != nil || nextFile != nil)
{
[buf appendString: indent];
[buf appendString: @"
\n"];
}
[buf appendString: indent];
if (isContentsDoc)
{
headerTag = @"h2";
}
else
{
headerTag = @"h1";
}
[buf appendFormat: @"<%@>
", headerTag, base];
[self outputText: [children firstChild] to: buf];
[buf appendFormat: @"\n", headerTag];
children = [children nextElement];
if ([[children name] isEqual: @"author"] == YES)
{
[buf appendString: indent];
[buf appendString: @"
Authors
\n"];
[buf appendString: indent];
[buf appendString: @"
\n"];
[self incIndent];
while ([[children name] isEqual: @"author"] == YES)
{
GSXMLNode *author = children;
GSXMLNode *tmp;
GSXMLNode *email = nil;
GSXMLNode *url = nil;
GSXMLNode *desc = nil;
NSString *name;
name = [[author attributes] objectForKey: @"name"];
name = [name stringByTrimmingSpaces];
if ([name length] == 0)
{
name = [NSString stringWithFormat: @"Generated by %@",
NSFullUserName()];
}
children = [children nextElement];
tmp = [author firstChildElement];
if ([[tmp name] isEqual: @"email"] == YES)
{
email = tmp;
tmp = [tmp nextElement];
}
if ([[tmp name] isEqual: @"url"] == YES)
{
url = tmp;
tmp = [tmp nextElement];
}
if ([[tmp name] isEqual: @"desc"] == YES)
{
desc = tmp;
}
[buf appendString: indent];
if (url == nil)
{
[buf appendString: @"- "];
[buf appendString: [name stringByEscapingXML]];
}
else
{
[buf appendString: @"
- "];
[buf appendString: [name stringByEscapingXML]];
[buf appendString: @""];
}
if (email != nil)
{
//
// Add a beautifier ' ' otherwise we'll get a
//
- John Doe(\n"];
[buf appendString: indent];
[buf appendString: @"
- \n"];
if (desc != nil)
{
[self incIndent];
[self outputNode: desc to: buf];
[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 outputText: [children firstChild] to: buf];
[buf appendString: @"
\n"];
children = [children nextElement];
}
if ([[children name] isEqual: @"date"] == YES)
{
GSXMLNode *tmp = [children firstChild];
NSString *str;
[buf appendString: indent];
[buf appendString: @"
Date: "];
if (nil == tmp
|| ([tmp type] == XML_TEXT_NODE
&& [[[tmp escapedContent] stringByTrimmingSpaces]
length] == 0))
{
str = [NSString stringWithFormat: @"Generated at %@",
[NSDate date]];
[buf appendString: str];
}
else
{
[self outputText: tmp to: buf];
}
[buf appendString: @"
\n"];
children = [children nextElement];
}
if ([[children name] isEqual: @"abstract"] == YES)
{
GSXMLNode *tmp = [children firstChild];
[buf appendString: indent];
[buf appendString: @"
\n"];
[self incIndent];
while (tmp != nil)
{
tmp = [self outputBlock: tmp to: buf inPara: NO];
}
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
children = [children nextElement];
}
if ([[children name] isEqual: @"copy"] == YES)
{
[buf appendString: indent];
[buf appendString: @"
Copyright: (C) "];
[self outputText: [children firstChild] to: buf];
[buf appendString: @"
\n"];
}
}
else if ([name isEqual: @"heading"] == YES)
{
if (heading == nil)
{
}
else
{
[buf appendString: indent];
[buf appendString: @"<"];
[buf appendString: heading];
[buf appendString: @">"];
[buf appendFormat: @"
",
chap, sect, ssect, sssect];
[self outputText: children to: buf];
[buf appendString: @"\n"];
heading = nil;
}
}
else if ([name isEqual: @"index"] == YES)
{
NSString *scope = [prop objectForKey: @"scope"];
NSString *type = [prop objectForKey: @"type"];
NSString *target = [prop objectForKey: @"target"];
NSString *title = [type capitalizedString];
NSString *style = [prop objectForKey: @"style"];
[self outputIndex: type scope: scope title: title style: style
target: target to: buf ];
}
else if ([name isEqual: @"ivar"] == YES) // %phrase
{
[buf appendString: @"
"];
[self outputText: children to: buf];
[buf appendString: @""];
}
else if ([name isEqual: @"ivariable"] == YES)
{
NSString *n = [prop objectForKey: @"name"];
NSString *t = [prop objectForKey: @"type"];
NSString *v = [prop objectForKey: @"validity"];
NSString *s;
GSXMLNode *tmp;
tmp = firstElement(children);
[buf appendString: indent];
[buf appendString: @"
"];
s = [self makeLink: n ofType: @"ivariable" inUnit: nil isRef: NO];
if (s != nil)
{
[buf appendString: s];
[buf appendString: n];
[buf appendString: @""];
}
else
{
[buf appendString: n];
}
[buf appendString: @"
\n"];
if (v == nil)
{
v = @"public";
}
[buf appendFormat: @"%@@%@ %@
%@;
\n", indent, v, t, n];
/*
* List standards with which ivar complies
*/
[self outputVersion: prop to: buf];
if ([[tmp name] isEqual: @"desc"])
{
[self outputNode: tmp to: buf];
}
[buf appendString: indent];
[buf appendString: @"
\n"];
}
else if ([name isEqual: @"label"] == YES) // %anchor
{
NSString *text;
NSString *val;
text = [children escapedContent];
val = [prop objectForKey: @"id"];
if (val == nil)
{
val = text;
if (val == nil) val = @"";
}
[buf appendString:
[self makeAnchor: val ofType: @"label" name: text]];
}
else if ([name isEqual: @"macro"] == YES)
{
NSString *mac;
NSString *str;
NSString *s;
GSXMLNode *tmp = children;
BOOL hadArg = NO;
mac = [prop objectForKey: @"name"];
str = [NSString stringWithFormat: @" %@", mac];
children = nil;
while (tmp != nil)
{
if ([tmp type] == XML_ELEMENT_NODE)
{
if ([[tmp name] isEqual: @"arg"] == YES)
{
GSXMLNode *t = [tmp firstChild];
if (hadArg == YES)
{
str = [str stringByAppendingString: @", "];
}
else
{
str = [str stringByAppendingString: @"("];
}
str = [str stringByAppendingString: @"
"];
while (t != nil)
{
if ([t type] == XML_TEXT_NODE)
{
NSString *content = [t escapedContent];
if (content == nil) content = @"";
str = [str stringByAppendingString: content];
}
t = [t next];
}
str = [str stringByAppendingString: @""];
hadArg = YES;
}
else if ([[tmp name] isEqual: @"vararg"] == YES)
{
if (hadArg == YES)
{
str = [str stringByAppendingString: @"
,..."];
}
else
{
str = [str stringByAppendingString: @"
(..."];
}
children = [tmp nextElement];
hadArg = YES;
break;
}
else
{
children = tmp;
break;
}
}
tmp = [tmp nextElement];
}
/*
* Output macro heading.
*/
[buf appendString: indent];
[buf appendString: @"
"];
s = [self makeLink: mac ofType: @"macro" isRef: NO];
if (s != nil)
{
[buf appendString: s];
[buf appendString: mac];
[buf appendString: @""];
}
else
{
[buf appendString: mac];
}
[buf appendString: @"
\n"];
[buf appendString: indent];
[buf appendString: str];
if (hadArg == YES)
{
[buf appendString: @")"];
}
[buf appendString: @"
\n"];
node = firstElement(children);
if ([[node name] isEqual: @"declared"] == YES)
{
[self outputNode: node to: buf];
node = [node nextElement];
}
children = node;
if ([[children name] isEqual: @"standards"])
{
node = [node nextElement];
}
[self outputVersion: prop to: buf];
if ([[node name] isEqual: @"desc"])
{
[self outputNode: node to: buf];
}
[buf appendString: indent];
[buf appendString: @"
\n"];
}
else if ([name isEqual: @"method"] == YES)
{
NSString *sel;
NSString *str;
GSXMLNode *tmp = children;
BOOL hadArg = NO;
[buf appendString:@"
\n"];
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 firstChild];
str = [str stringByAppendingString: @""];
while (t != nil)
{
if ([t type] == XML_TEXT_NODE)
{
NSString *content = [t escapedContent];
if (content == nil) content = @"";
sel = [sel stringByAppendingString: content];
// these nbsp added for readability, but must
// be removed below when making href link
sel = [sel stringByAppendingString: @" "];
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 firstChild];
NSString *s;
s = [[tmp attributes] objectForKey: @"type"];
s = [self typeRef: s];
str = [str stringByAppendingFormat: @" (%@)", s];
while (t != nil)
{
if ([t type] == XML_TEXT_NODE)
{
NSString *content = [t escapedContent];
if (content == nil) content = @"";
str = [str stringByAppendingString: 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 nextElement];
break;
}
else
{
children = tmp;
break;
}
}
tmp = [tmp nextElement];
}
if ([sel length] > 1)
{
NSString *s;
NSMutableString *linkRef;
/*
* Output selector heading.
*/
[buf appendString: indent];
[buf appendString: @"
"];
// get rid of nbsps put in for readability above
linkRef = [NSMutableString stringWithCapacity: [sel length]];
[linkRef setString:sel];
[linkRef replaceString: @" " withString: @""];
s = [self makeLink: linkRef
ofType: @"method"
inUnit: nil
isRef: NO];
if (s != nil)
{
[buf appendString: s];
[buf appendString: [sel substringFromIndex: 1]];
[buf appendString: @""];
}
else
{
[buf appendString: [sel substringFromIndex: 1]];
}
[buf appendString: @"
\n"];
[buf appendString: indent];
[buf appendString: str];
[buf appendString: @";
\n"];
node = firstElement(children);
/*
* List standards with which method complies
*/
children = node;
if ([[children name] isEqual: @"standards"])
{
node = [node nextElement];
}
[self outputVersion: prop to: buf];
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 must "
@"override this method.
\n"];
}
else if ([str isEqual: @"dummy"] == YES)
{
[buf appendString: @"An empty method provided for subclasses "
@"to override.
\n"];
}
else if ([str isEqual: @"never"] == YES)
{
[buf appendString: @"Subclasses must NOT "
@"override this method.
\n"];
}
if ([[node name] isEqual: @"desc"])
{
[self outputNode: node to: buf];
}
[buf appendString: indent];
[buf appendString: @"
\n"];
}
[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"];
GSXMLNode *tmp = [node firstChild];
NSString *c = [prop objectForKey: @"class"];
NSString *s;
// fill in default value
if ((type == nil) || [type isEqual: @""])
{
type = @"label";
}
if ([type isEqual: @"method"] || [type isEqual: @"ivariable"])
{
s = [self makeLink: r ofType: type inUnit: c isRef: YES];
}
else
{
s = [self makeLink: r ofType: type isRef: YES];
/**
* 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.
*/
if (s == nil && [type isEqual: @"function"] == YES)
{
s = [self makeLink: r ofType: @"macro" isRef: YES];
}
}
if (s == nil)
{
if (warn)
{
NSString *ref;
ref = [NSString stringWithFormat:
@" (referenced from %@ in %@).",
base, fileName];
if (c == nil)
{
NSLog(@"Warning - location of %@ '%@'"
@" not found or not unique %@.",
type, r, ref);
}
else
{
NSLog(@"Warning - location of the %@ version of %@ '%@'"
@" not found %@.", c, type, r, ref);
}
}
if (tmp == nil)
{
[buf appendString: r];
}
else
{
[self outputText: tmp to: buf];
}
[buf appendString: @"\n"];
}
else
{
[buf appendString: s];
if (tmp == nil)
{
[buf appendString: r];
}
else
{
[self outputText: tmp to: buf];
}
[buf appendString: @"\n"];
}
}
else if ([name isEqual: @"protocol"] == YES)
{
NSString *value = [prop objectForKey: @"name"];
unit = [NSString stringWithFormat: @"(%@)", value];
[buf appendString: indent];
[buf appendString: @"
"];
[buf appendString:
[self makeAnchor: unit ofType: @"protocol" name: value]];
[buf appendString: @"
\n"];
[self outputUnit: node to: buf];
unit = nil;
}
else if ([name isEqual: @"EOEntity"] == YES
|| [name isEqual: @"EOModel"] == YES)
{
NSLog(@"Element '%@' not implemented", name); // FIXME
}
else if ([name isEqual: @"section"] == YES)
{
heading = @"h2";
sect++;
ssect = 0;
sssect = 0;
[self outputNodeList: children to: buf];
heading = @"h1";
}
else if ([name isEqual: @"site"] == YES)
{
[buf appendString: @"
"];
[self outputText: children to: buf];
[buf appendString: @""];
}
else if ([name isEqual: @"standards"])
{
}
else if ([name isEqual: @"strong"] == YES)
{
[buf appendString: @"
"];
[self outputText: children to: buf];
[buf appendString: @""];
}
else if ([name isEqual: @"subsect"] == YES)
{
heading = @"h3";
ssect++;
sssect = 0;
[self outputNodeList: children to: buf];
heading = @"h2";
}
else if ([name isEqual: @"subsubsect"] == YES)
{
heading = @"h4";
sssect++;
[self outputNodeList: children to: buf];
heading = @"h3";
}
else if ([name isEqual: @"type"] == YES)
{
NSString *nam;
NSString *str;
NSString *s;
nam = [prop objectForKey: @"name"];
str = [prop objectForKey: @"type"];
str = [self typeRef: str];
str = [NSString stringWithFormat: @"typedef %@ %@", str, nam];
/*
* Output typedef heading.
*/
[buf appendString: indent];
[buf appendString: @"
"];
s = [self makeLink: nam ofType: @"type" isRef: NO];
if (s != nil)
{
[buf appendString: s];
[buf appendString: nam];
[buf appendString: @""];
}
else
{
[buf appendString: nam];
}
[buf appendString: @"
\n"];
[buf appendString: indent];
[buf appendString: str];
[buf appendString: @";
\n"];
node = firstElement(children);
if (node != nil && [[node name] isEqual: @"declared"] == YES)
{
[self outputNode: node to: buf];
node = [node nextElement];
}
children = node;
if ([[children name] isEqual: @"standards"])
{
node = [node nextElement];
}
[self outputVersion: prop to: buf];
if (node != nil && [[node name] isEqual: @"desc"] == YES)
{
[self outputNode: node to: buf];
}
[buf appendString: indent];
[buf appendString: @"
\n"];
}
else if ([name isEqual: @"uref"] == YES)
{
[buf appendString: @"
"];
[self outputText: children to: buf];
[buf appendString: @""];
}
else if ([name isEqual: @"url"] == YES)
{
// create an HREF as before but use the URL itself as marker text
[buf appendString: @"
"];
[buf appendString: [prop objectForKey: @"url"]];
[buf appendString: @""];
}
else if ([name isEqual: @"var"] == YES) // %phrase
{
[buf appendString: @"
"];
[self outputText: children to: buf];
[buf appendString: @""];
}
else if ([name isEqual: @"variable"] == YES)
{
NSString *nam;
NSString *str;
NSString *s;
nam = [prop objectForKey: @"name"];
str = [prop objectForKey: @"type"];
str = [self typeRef: str];
str = [str stringByAppendingFormat: @" %@", nam];
/*
* Output variable heading.
*/
[buf appendString: indent];
[buf appendString: @"
"];
s = [self makeLink: nam ofType: @"variable" isRef: NO];
if (s != nil)
{
[buf appendString: s];
[buf appendString: nam];
[buf appendString: @""];
}
else
{
[buf appendString: nam];
}
[buf appendString: @"
\n"];
[buf appendString: indent];
[buf appendString: str];
[buf appendString: @";
\n"];
node = firstElement(children);
if ([[node name] isEqual: @"declared"] == YES)
{
[self outputNode: node to: buf];
node = [node nextElement];
}
children = node;
if ([[children name] isEqual: @"standards"])
{
node = [node nextElement];
}
[self outputVersion: prop to: buf];
if ([[node name] isEqual: @"desc"])
{
[self outputNode: node to: buf];
}
[buf appendString: indent];
[buf appendString: @"
\n"];
}
else
{
GSXMLNode *tmp;
/*
* Try outputting as any of the list elements.
*/
tmp = [self outputList: node to: buf];
if (tmp == node)
{
NSLog(@"Element '%@' not implemented", name); // FIXME
}
}
}
LEAVE_POOL
}
/** 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.
*/
- (void) outputNodeList: (GSXMLNode*)node to: (NSMutableString*)buf
{
while (node != nil)
{
GSXMLNode *next = [node nextElement];
GSXMLNode *tmp;
tmp = [self outputText: node to: buf];
if (tmp == node)
{
[self outputNode: node to: buf];
node = next;
}
else
{
node = tmp;
}
}
}
/**
* 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 firstChild] 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)
{
GSXMLNode *c = [node firstChild];
[buf appendString: @"
"];
[self outputText: c to: buf];
[buf appendString: @"
\n"];
return [node next];
}
else if ([n isEqual: @"embed"] == YES)
{
NSLog(@"Element 'embed' not supported");
return [node next];
}
else if ([n isEqual: @"index"] == YES)
{
[self outputNode: node to: buf];
return [node next];
}
else if ([textNodes member: n] != nil)
{
[buf appendString: indent];
node = [self outputText: node to: buf];
[buf appendString: @"\n"];
return node;
}
else
{
NSLog(@"Non-block element '%@' in block ...", n);
NSLog(@"%@",node);
return nil;
}
}
[buf appendString: indent];
node = [self outputText: node to: buf];
[buf appendString: @"\n"];
return node;
}
/**
* 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 firstChildElement];
if ([name isEqual: @"list"] == YES)
{
[buf appendString: indent];
[buf appendString: @"
\n"];
[self incIndent];
while (children != nil)
{
GSXMLNode *tmp = [children firstChild];
[buf appendString: indent];
[buf appendString: @"- \n"];
[self incIndent];
while (tmp != nil)
{
tmp = [self outputBlock: tmp to: buf inPara: NO];
}
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
children = [children nextElement];
}
[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)
{
GSXMLNode *tmp = [children firstChild];
[buf appendString: indent];
[buf appendString: @"- \n"];
[self incIndent];
while (tmp != nil)
{
tmp = [self outputBlock: tmp to: buf inPara: NO];
}
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
children = [children nextElement];
}
[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)
{
GSXMLNode *tmp;
[buf appendString: indent];
[buf appendString: @"- "];
[self outputText: [children firstChild] to: buf];
[buf appendString: @"
\n"];
children = [children nextElement];
[buf appendString: indent];
[buf appendString: @"- \n"];
[self incIndent];
tmp = [children firstChild];
while (tmp != nil)
{
tmp = [self outputBlock: tmp to: buf inPara: NO];
}
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
children = [children nextElement];
}
[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)
{
GSXMLNode *tmp;
[buf appendString: indent];
[buf appendString: @"- "];
[self outputText: [children firstChild] to: buf];
[buf appendString: @"
\n"];
children = [children nextElement];
[buf appendString: indent];
[buf appendString: @"- \n"];
[self incIndent];
tmp = [children firstChild];
while (tmp != nil)
{
tmp = [self outputBlock: tmp to: buf inPara: NO];
}
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
children = [children nextElement];
}
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
}
else if ([name isEqual: @"dictionary"] == YES)
{
[buf appendString: indent];
[buf appendString: @"
{\n"];
[self incIndent];
// all children should be dictionaryItems w/key and value attributes;
// if the value attribute is absent, the content is the value
for (; children != nil; children = [children nextElement])
{
GSXMLNode *dItem = children;
NSDictionary *dProp = [dItem attributes];
NSString *value = [dProp objectForKey: @"value"];
GSXMLNode *dChild;
if (![@"dictionaryItem" isEqualToString: [dItem name]])
{
continue;
}
[buf appendString: indent];
[buf appendString: @"- "];
[buf appendString:
[[dProp objectForKey: @"key"] stringByEscapingXML]];
[buf appendString: @" =
\n"];
[buf appendString: indent];
[buf appendString: @"- \n"];
[self incIndent];
if (value != nil)
{
[buf appendString: [value stringByEscapingXML]];
}
else
{
dChild = [dItem firstChildElement];
if ( dChild == nil )
{
// no elements, just text contents
dChild = [dItem firstChild];
[buf appendString: indent];
}
[self outputBlock: dChild to: buf inPara: NO];
//PENDING use returne value for dItem?
}
[buf appendString: @"\n"];
[self decIndent];
[buf appendString: indent];
[buf appendString: @";
\n"];
}
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
}\n"];
}
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)
{
NSString *str = [node escapedContent];
if (str == nil) str = @"";
[buf appendString: str];
}
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
{
NSMutableDictionary *protocols = nil;
NSArray *a;
NSMutableString *ivarBuf = ivarsAtEnd ?
(id)[NSMutableString stringWithCapacity: 1024] : nil;
NSDictionary *prop = [node attributes];
GSXMLNode *tmp;
/* First scan the top level children for protocols we conform to.
*/
tmp = [node firstChildElement];
while ([[tmp name] isEqualToString: @"declared"])
{
tmp = [tmp nextElement];
}
while ([[tmp name] isEqualToString: @"conform"])
{
NSString *p;
p = [[[tmp firstChild] escapedContent] stringByTrimmingSpaces];
if ([p length] > 0)
{
NSString *n;
NSString *u;
n = [NSString stringWithFormat: @"(%@)", p];
u = [self makeURL: n ofType: @"protocol" isRef: YES];
if (u)
{
if (nil == protocols)
{
protocols = [NSMutableDictionary dictionary];
}
[protocols setObject: u forKey: p];
}
}
tmp = [tmp nextElement];
}
if (graphviz && [[node name] isEqualToString: @"class"])
{
NSDictionary *prop = [node attributes];
NSString *cNam = [prop objectForKey: @"name"];
NSString *sNam = [prop objectForKey: @"super"];
NSMutableString *dot = [NSMutableString string];
NSString *url = nil;
NSString *svg;
NSEnumerator *e;
NSString *p;
cNam = [cNam stringByTrimmingSpaces];
sNam = [sNam stringByTrimmingSpaces];
url = [self makeURL: sNam ofType: @"class" isRef: YES];
/* Make sure a URL local to the HTML file includes the
* file name so it's not interpreted local to the SVG.
*/
/*
if ([url hasPrefix: @"#"])
{
NSString *file = [fileName lastPathComponent];
NSString *ext = [file pathExtension];
if ([ext isEqual: @"gsdoc"])
{
file = [file stringByDeletingPathExtension];
}
if (NO == [ext isEqual: @"html"])
{
file = [file stringByAppendingPathExtension: @"html"];
}
url = [file stringByAppendingString: url];
}
*/
[dot appendFormat: @"digraph class_%@ {\n", cNam];
[dot appendString: @" rankdir = \"TB\";\n"];
[dot appendString: @" {\n"];
[dot appendString: @" node [margin=0 "
@" fontsize=24 width=0.5 shape=rectangle style=filled]\n"];
if (sNam)
{
[dot appendFormat: @" %@ [class=figure_super", sNam];
if (url)
{
[dot appendFormat: @" URL=\"%@\"", url];
}
[dot appendString: @"]\n"];
[dot appendFormat: @" %@ [class=figure_class]\n",
cNam];
}
else
{
sNam = cNam; // This is a root class ...
[dot appendFormat: @" %@ [class=figure_root]\n",
cNam];
}
if (protocols)
{
e = [protocols keyEnumerator];
while ((p = [e nextObject]) != nil)
{
[dot appendFormat: @" p_%@ [class=figure_protocol"
@" label=\"%@\" URL=\"%@\" shape=hexagon]\n",
p, p, [protocols objectForKey: p]];
}
}
[dot appendString: @" }\n"];
[dot appendFormat: @" %@ -> %@\n", sNam, cNam];
if (protocols)
{
NSArray *keys = [protocols allKeys];
keys = [keys sortedArrayUsingSelector: @selector(compare:)];
e = [keys objectEnumerator];
while ((p = [e nextObject]) != nil)
{
[dot appendFormat: @" p_%@ -> %@\n", p, cNam];
}
}
[dot appendString: @"}"];
if ((svg = filter(dot, verbose)) != nil)
{
[buf appendString: svg];
}
}
node = [node firstChildElement];
if (node != nil && [[node name] isEqual: @"declared"] == YES)
{
[self outputNode: node to: buf];
node = [node nextElement];
}
while ([[node name] isEqual: @"conform"])
{
node = [node nextElement];
}
if (protocols)
{
NSArray *keys = [protocols allKeys];
NSEnumerator *e;
NSString *p;
keys = [keys sortedArrayUsingSelector: @selector(compare:)];
e = [keys objectEnumerator];
[buf appendString: indent];
[buf appendString: @"
\n"];
[self incIndent];
[buf appendString: indent];
[buf appendString: @"\n"];
[self incIndent];
[buf appendString: indent];
[buf appendString: @"- Conforms to:
\n"];
while ((p = [e nextObject]) != nil)
{
NSString *u = [protocols objectForKey: p];
[buf appendString: indent];
[buf appendString: @"- "];
[buf appendString: p];
[buf appendString: @"
\n"];
}
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
[self decIndent];
[buf appendString: indent];
[buf appendString: @"
\n"];
}
while (node != nil && [[node name] isEqual: @"desc"] == NO)
{
node = [node nextElement];
}
[self outputVersion: prop to: buf];
if (node != nil && [[node name] isEqual: @"desc"] == YES)
{
[self outputNode: node to: buf];
node = [node nextElement];
}
if (node != nil && [[node name] isEqual: @"ivariable"] == YES)
{
NSMutableString *ibuf = buf;
/*
* If want instance variables at end, throw it all into an alternate
* buffer and just put a link here; later alt buf must be appended.
*/
if (ivarsAtEnd)
{
ibuf = ivarBuf;
[buf appendString: indent];
[buf appendString: @"
\n"];
[buf appendString: indent];
[buf appendFormat: @"
Instance Variables\n",
classname];
[buf appendString: indent];
[buf appendString: @"
\n"];
[ibuf appendFormat: @"
", classname];
}
[ibuf appendString: indent];
[ibuf appendString: @"
\n"];
[ibuf appendString: indent];
[ibuf appendFormat: @"Instance Variables for %@ Class
\n",
classname];
while (node != nil && [[node name] isEqual: @"ivariable"] == YES)
{
[self outputNode: node to: ibuf];
node = [node nextElement];
}
[ibuf appendString: indent];
[ibuf appendString: @"
\n"];
}
a = [localRefs methodsInUnit: unit];
if ([a count] > 0)
{
[self outputIndex: @"method"
scope: @"global"
title: @"Method summary"
style: nil
target: nil
to: buf];
[buf appendString: indent];
[buf appendString: @"
\n"];
while (node != nil)
{
if ([[node name] isEqual: @"method"] == YES)
{
[self outputNode: node to: buf];
}
node = [node nextElement];
}
}
// if had ivars docs, insert them now
if (ivarsAtEnd)
{
[buf appendString: ivarBuf];
}
}
- (void) outputVersion: (NSDictionary*)prop to: (NSMutableString*)buf
{
NSString *ovadd = [prop objectForKey: @"ovadd"];
NSString *gvadd = [prop objectForKey: @"gvadd"];
NSString *ovdep = [prop objectForKey: @"ovdep"];
NSString *gvdep = [prop objectForKey: @"gvdep"];
NSString *ovrem = [prop objectForKey: @"ovrem"];
NSString *gvrem = [prop objectForKey: @"gvrem"];
const char *str;
int maj;
int min;
int sub;
if ([ovadd length] > 0)
{
int add;
int dep;
int rem;
str = [ovadd UTF8String];
if (str != 0 && sscanf(str, "%d.%d.%d", &maj, &min, &sub) == 3)
add = maj * 10000 + min * 100 + sub;
else
add = 0;
str = [ovdep UTF8String];
if (str != 0 && sscanf(str, "%d.%d.%d", &maj, &min, &sub) == 3)
dep = maj * 10000 + min * 100 + sub;
else
dep = 0;
str = [ovrem UTF8String];
if (str != 0 && sscanf(str, "%d.%d.%d", &maj, &min, &sub) == 3)
rem = maj * 10000 + min * 100 + sub;
else
rem = 0;
[buf appendString: indent];
[buf appendString: @"\n"];
[buf appendString: @"Availability: "];
if (add < GS_API_OSSPEC)
{
[buf appendString: @"Not in OpenStep/MacOS-X"];
}
else if (add < GS_API_OPENSTEP)
{
[buf appendString: @"OpenStep"];
}
else if (add < GS_API_MACOSX)
{
[buf appendString: @"OPENSTEP "];
[buf appendString: ovadd];
}
else
{
[buf appendString: @"MacOS-X "];
[buf appendString: ovadd];
}
if (dep > add)
{
[buf appendString: @" deprecated at "];
if (dep < GS_API_MACOSX)
{
[buf appendString: @"OPENSTEP "];
[buf appendString: ovdep];
}
else
{
[buf appendString: @"MacOS-X "];
[buf appendString: ovdep];
}
}
if (rem > add)
{
[buf appendString: @" removed at "];
if (rem < GS_API_MACOSX)
{
[buf appendString: @"OPENSTEP "];
[buf appendString: ovrem];
}
else
{
[buf appendString: @"MacOS-X "];
[buf appendString: ovrem];
}
}
if ([gvadd length] > 0)
{
[buf appendString: @", "];
[buf appendString: project];
if ([gvadd isEqualToString: @"0.0.0"] == NO)
{
[buf appendString: @" "];
[buf appendString: gvadd];
}
if ([gvdep length] > 0)
{
[buf appendString: @" deprecated at "];
[buf appendString: gvdep];
}
if ([gvrem length] > 0)
{
[buf appendString: @" Likely to be changed/moved/removed at "];
[buf appendString: gvrem];
}
}
[buf appendString:@"
\n"];
[buf appendString: @"
\n"];
}
else if ([gvadd length] > 0)
{
[buf appendString: indent];
[buf appendString: @"\n"];
[buf appendString: @"Availability: "];
[buf appendString: project];
if ([gvadd isEqualToString: @"0.0.0"] == NO)
{
[buf appendString: @" "];
[buf appendString: gvadd];
}
if ([gvdep length] > 0)
{
[buf appendString: @" deprecated at "];
[buf appendString: gvdep];
}
[buf appendString: @"
\n"];
if ([gvrem length] > 0)
{
[buf appendString: @" Likely to be changed/moved/removed at "];
[buf appendString: gvrem];
}
[buf appendString:@"
\n"];
[buf appendString: @"
\n"];
}
}
/**
* 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];
s = [self makeLink: n ofType: @"protocol" isRef: YES];
if (s != nil)
{
s = [s stringByAppendingString: t];
t = [s stringByAppendingString: @""];
}
return t;
}
- (void) setGlobalRefs: (AGSIndex*)r
{
ASSIGN(globalRefs, r);
}
- (void) setLocalRefs: (AGSIndex*)r
{
ASSIGN(localRefs, r);
}
- (void) setProjectRefs: (AGSIndex*)r
{
ASSIGN(projectRefs, r);
}
- (void) setInstanceVariablesAtEnd: (BOOL)val
{
ivarsAtEnd = val;
}
/**
* 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 *str = [t stringByTrimmingSpaces];
NSString *s;
unsigned end = [str length];
unsigned start;
NSMutableString *ms = nil;
NSRange er;
NSRange sr;
if (end == 0)
{
return nil;
}
t = str;
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 = [str substringWithRange: NSMakeRange(start, end - start)];
s = [self makeLink: t ofType: @"type" isRef: YES];
if (s == nil)
{
s = [self makeLink: t ofType: @"class" isRef: YES];
}
s = [s stringByAppendingFormat: @"%@", t];
if (s != nil && [str length] == [t length])
{
return s;
}
/*
* Look for protocol spec.
*/
sr = [str rangeOfString: @"<"];
if (sr.length == 0)
{
sr = [str rangeOfString: @"<"];
}
if (sr.length == 0)
{
sr = [str rangeOfString: @"<"];
}
er = [str rangeOfString: @">"];
if (er.length == 0)
{
er = [str rangeOfString: @">"];
}
if (er.length == 0)
{
er = [str rangeOfString: @">"];
}
/*
* Substitute in protocol references.
*/
if (sr.length > 0 && er.length > 0 && er.location > sr.location)
{
NSString *pString;
NSRange r;
NSArray *protocols;
unsigned i;
r = NSMakeRange(NSMaxRange(sr), er.location - NSMaxRange(sr));
pString = [str substringWithRange: r];
protocols = [pString componentsSeparatedByString: @","];
ms = [str mutableCopy];
pString = @"";
for (i = 0; i < [protocols count]; i++)
{
NSString *p = [protocols objectAtIndex: i];
NSString *l;
l = [self makeLink: [NSString stringWithFormat: @"(%@)", p]
ofType: @"protocol"
isRef: YES];
if (l != nil)
{
p = [l stringByAppendingFormat: @"%@", p];
}
if (i > 0)
{
pString = [pString stringByAppendingString: @","];
}
pString = [pString stringByAppendingString: p];
}
[ms replaceCharactersInRange: r withString: pString];
}
/*
* Substitute in basic type reference.
*/
if (s != nil)
{
if (ms == nil)
{
ms = [str mutableCopy];
}
[ms replaceCharactersInRange: NSMakeRange(start, end - start)
withString: s];
}
if (ms != nil)
{
str = AUTORELEASE(ms);
}
return str;
}
@end