New args to enable generation of relative links to other projects.

Author: rfm

Tools/AGSOutput.m

@@ -1379,6 +1379,8 @@ - (void) outputUnit: (NSMutableDictionary*)d to: (NSMutableString*)str
 	      to: str];
 }
 
+static NSString	*padding[100];
+
 - (unsigned) reformat: (NSString*)str
 	   withIndent: (unsigned)ind
 		   to: (NSMutableString*)buf
@@ -1387,8 +1389,20 @@ - (unsigned) reformat: (NSString*)str
   unsigned	l = [str length];
   NSRange	r = [str rangeOfString: @"<example"];
   unsigned	i = 0;
+  unsigned	c;
   NSArray	*a;
 
+  if (nil == padding[0])
+    {
+      int	p;
+
+      padding[0] = @" ";
+      for (p = 1; p < sizeof(padding)/sizeof(*padding); p++)
+	{
+	  padding[p] = [[padding[p-1] stringByAppendingString: @" "] copy];
+	}
+    }
+
   /*
    * Split out <example>...</example> sequences and output them literally.
    * All other text has reformatting applied as necessary.
@@ -1442,10 +1456,11 @@ - (unsigned) reformat: (NSString*)str
     }
 
   /*
-   * Split the string up into parts separated by newlines.
+   * Split the string up into parts separated by whitespace.
    */
   a = [self split: str];
-  for (i = 0; i < [a count]; i++)
+  c = [a count];
+  for (i = 0; i < c; i++)
     {
       unsigned int	j;
 
@@ -1460,9 +1475,14 @@ - (unsigned) reformat: (NSString*)str
 	       */
 	      ind -= 2;
 	    }
-	  for (j = 0; j < ind; j++)
+	  while (j < ind)
 	    {
-	      [buf appendString: @" "];
+	      unsigned	size = ind - j;
+
+	      if (size > sizeof(padding)/sizeof(*padding))
+		size = sizeof(padding)/sizeof(*padding);
+	      [buf appendString: padding[size - 1]];
+	      j += size;
 	    }
 	  [buf appendString: str];
 	  [buf appendString: @"\n"];
@@ -1472,9 +1492,14 @@ - (unsigned) reformat: (NSString*)str
 	  unsigned	size = 70 - ind - [str length];
 	  unsigned	end;
 
-	  for (j = 0; j < ind; j++)
+	  if (j < ind)
 	    {
-	      [buf appendString: @" "];
+	      unsigned	size = ind - j;
+
+	      if (size > sizeof(padding)/sizeof(*padding))
+		size = sizeof(padding)/sizeof(*padding);
+	      [buf appendString: padding[size - 1]];
+	      j += size;
 	    }
 	  end = [self fitWords: a
 			  from: i

Tools/autogsdoc.m

@@ -354,6 +354,21 @@ source files (not headers), and more importantly, it is used as the
 	searched for in <code>DocumentationDirectory</code> (even though they
         may not have been autogenerated).
       </item>
+      <item><strong>InstallationDomain</strong>
+	May be used to specify where the documentation is to be installed,
+	so that relative references to documentation in other projects can
+	be used (otherwise references to other docuentation will use the
+	absolute loacation of that documentation in the filesystem).
+	By default this is the LOCAL domain, but it can also be set to
+	SYSTEM, NETWORK, or USER.
+      </item>
+      <item><strong>InstallDir</strong>
+	This is used to enable generation of HTML output with relative links
+	to documentation created for other projects.  The value of this must
+	be the relative path at which this documentation will be installed
+	within the installation domain (see -InstallationDomain) used.
+	Relative links will not work until the documentation is installed.
+      </item>
       <item><strong>Files</strong>
 	Specifies the name of a file containing a list of file names as
 	a property list array <em>(name1,name2,...)</em> format.  If this
@@ -623,16 +638,42 @@ standard PropertyList format (not the XML format of OS X), using
 #import "GNUstepBase/NSString+GNUstepBase.h"
 #import "GNUstepBase/NSMutableString+GNUstepBase.h"
 
+static NSString *
+commonRoot(NSString *s1, NSString *s2)
+{
+  NSString	*s;
+  unsigned	l;
+
+  if (nil == s1) return s2;
+
+  s = [s1 commonPrefixWithString: s2 options: NSLiteralSearch];
+  l = [s length];
+  while (l > 0 && [s characterAtIndex: l - 1] != '/')
+    {
+      l--;
+    }
+  if (0 == l)
+    {
+      NSLog(@"Unable to make relative links because projects '%@' and '%@'"
+	@" share no common prefix.", s1, s2);
+      exit(1);
+    }
+  return [s substringToIndex: l];
+}
+
 int
 main(int argc, char **argv, char **env)
 {
   NSProcessInfo		*proc;
   unsigned		i;
+  NSString		*str;
   NSMutableDictionary	*safe;
   NSDictionary		*argsRecognized;
   NSUserDefaults	*defs;
   NSFileManager		*mgr;
   NSString		*documentationDirectory;
+  int			installationDomain = 0;
+  NSString		*installDir;
   NSString		*declared;
   NSString		*headerDirectory;
   NSString		*project;
@@ -779,6 +820,10 @@ standard PropertyList format (not the XML format of OS X), using
       @"search for gsdoc files",
     @"DocumentationDirectory",
     @"\t\t\tSTR\t(\"\")\n\tname of file containing filenames to document",
+    @"InstallationDomain",
+    @"\t\t\tSTR\t(LOCAL)\n\tfor relative links, the expected installation domain",
+    @"InstallDir",
+    @"\t\t\tSTR\t(\"\")\n\tfor relative links, location within domain",
     @"Files",
     @"\t\t\tBOOL\t(NO)\n\tremove all generated files",
     @"Clean",
@@ -940,6 +985,25 @@ standard PropertyList format (not the XML format of OS X), using
                            error: NULL];
     }
 
+  str = [[defs stringForKey: @"InstallationlDomain"] uppercaseString];
+  if ([str isEqualToString: @"SYSTEM"])
+    installationDomain = NSSystemDomainMask;
+  else if ([str isEqualToString: @"LOCAL"])
+    installationDomain = NSLocalDomainMask;
+  else if ([str isEqualToString: @"NETWORK"])
+    installationDomain = NSNetworkDomainMask;
+  else if ([str isEqualToString: @"USER"])
+    installationDomain = NSUserDomainMask;
+  else if (nil == str)
+    installationDomain = NSLocalDomainMask;
+  else
+    {
+      NSLog(@"Bad value for -InstallationDomain. If specified this must be one of SYSTEM, LOCAL, NETWORK, or USER");
+      exit(1);
+    }
+
+  installDir = [defs stringForKey: @"InstallDir"];
+
   symbolDeclsFile = [documentationDirectory 
     stringByAppendingPathComponent: @"OrderedSymbolDeclarations.plist"];
 
@@ -1781,6 +1845,7 @@ standard PropertyList format (not the XML format of OS X), using
       NSMutableDictionary	*projects;
       NSString			*systemProjects;
       NSString			*localProjects;
+      NSString			*installRoot = nil;
       CREATE_AUTORELEASE_POOL (pool);
 
       localProjects = [defs stringForKey: @"LocalProjects"];
@@ -1833,6 +1898,8 @@ standard PropertyList format (not the XML format of OS X), using
 		      val
 			= [systemProjects stringByAppendingPathComponent: val];
 		      [projects setObject: val forKey: key];
+		      if (installDir)
+		        installRoot = commonRoot(installRoot, key);
 		    }
 		}
 	    }
@@ -1876,6 +1943,8 @@ standard PropertyList format (not the XML format of OS X), using
 		      val = [file stringByDeletingLastPathComponent];
 		      val = [localProjects stringByAppendingPathComponent: val];
 		      [projects setObject: val forKey: key];
+		      if (installDir)
+		        installRoot = commonRoot(installRoot, key);
 		    }
 		}
 	    }
@@ -1889,6 +1958,46 @@ standard PropertyList format (not the XML format of OS X), using
 	  NSEnumerator		*e = [projects keyEnumerator];
 	  NSMutableArray	*merged;
 	  NSString		*k;
+	  NSString		*relative = @"";
+	  unsigned		installLength = 0;
+
+	  if (installDir)
+	    {
+	      NSString	*base;
+	      NSString	*file;
+	      NSString	*path;
+
+	      base = [NSSearchPathForDirectoriesInDomains(
+	        NSDocumentationDirectory, installationDomain, NO) lastObject];
+	      base = [base stringByAppendingPathComponent: installDir];
+	      base = [base stringByStandardizingPath];
+	      file = [project stringByAppendingPathExtension: @"html"];
+	      path = [base stringByAppendingPathComponent: file];
+	      installRoot = commonRoot(installRoot, path);
+	      installLength = [installRoot length];
+	      if ([base length] < installLength)
+		{
+		  /* All referenced project documentation is relative to the
+		   * directory that this project will be installed in.
+		   */
+		  relative = @"";
+		}
+	      else
+		{
+		  unsigned	c;
+
+		  base = [base substringFromIndex: installLength];
+
+		  /* Build the prefix to get from the package being generated
+		   * up to the documentation installation root.
+		   */
+		  c = [[base componentsSeparatedByString: @"/"] count];
+		  while (c--)
+		    {
+		      relative = [relative stringByAppendingString: @"../"];
+		    }
+		}
+	    }
 
 	  merged = [NSMutableArray arrayWithCapacity: [projects count]];
 	  while ((k = [e nextObject]) != nil)
@@ -1923,6 +2032,14 @@ standard PropertyList format (not the XML format of OS X), using
 			{
 			  p = [k stringByDeletingLastPathComponent];
 			}
+		      if (installRoot)
+			{
+			  /* Replace the root part with the prefix
+			   * to make the path relative.
+			   */
+			  p = [p substringFromIndex: installLength];
+			  p = [relative stringByAppendingString: p];
+			}
 		      [tmp setDirectory: p];
 		      [globalRefs mergeRefs: [tmp refs] override: YES];
 		      RELEASE(tmp);