[JEDI.NET-commits] tools/JediDoc JediDoc.Analysis.bdsproj,NONE,1.1 JediDoc.Analysis.dpk,NONE,1.1 Jed

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/jedidotnet/tools/JediDoc
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv28000/tools/JediDoc

Added Files:
	JediDoc.Analysis.bdsproj JediDoc.Analysis.dpk 
	JediDoc.Console.bdsproj JediDoc.Console.dpr 
	JediDoc.Core.bdsproj JediDoc.Core.dpk JediDoc.Tool.bdsproj 
	JediDoc.Tool.dpk JediDoc.Xml.bdsproj JediDoc.Xml.dpk 
Log Message:
JediDoc tool initial check-in

--- NEW FILE: JediDoc.Analysis.dpk ---
package JediDoc.Analysis;

{$ALIGN 0}
{$ASSERTIONS ON}
{$BOOLEVAL OFF}
{$DEBUGINFO ON}
{$EXTENDEDSYNTAX ON}
{$IMPORTEDDATA ON}
{$IOCHECKS ON}
{$LOCALSYMBOLS ON}
{$LONGSTRINGS ON}
{$OPENSTRINGS ON}
{$OPTIMIZATION ON}
{$OVERFLOWCHECKS OFF}
{$RANGECHECKS OFF}
{$REFERENCEINFO ON}
{$SAFEDIVIDE OFF}
{$STACKFRAMES OFF}
{$TYPEDADDRESS OFF}
{$VARSTRINGCHECKS ON}
{$WRITEABLECONST OFF}
{$MINENUMSIZE 1}
{$IMAGEBASE $400000}
{$IMPLICITBUILD OFF}

requires
  Borland.Delphi,
  JediDoc.Core,
  Jedi.System;

contains
  JediDoc.System.Analysis in 'source\JediDoc.System.Analysis.pas';

[assembly: AssemblyTitle('JediDoc.Analysis')]
[assembly: AssemblyDescription('Jedi documentation tool analyzing classes')]
[assembly: AssemblyCompany('Project JEDI')]
[assembly: AssemblyProduct('JediDoc documentation tool')]
[assembly: AssemblyCopyright('Copyright © 2004, 2005 Project JEDI')]
[assembly: AssemblyTrademark('')]
[assembly: AssemblyCulture('')]
[assembly: AssemblyVersion('1.0.1.0')]
[assembly: AssemblyDelaySign(false)]
[assembly: AssemblyKeyFile('')]
[assembly: AssemblyKeyName('')]
[assembly: ComVisible(False)]

end.

--- NEW FILE: JediDoc.Core.dpk ---
package JediDoc.Core;

{$ALIGN 0}
{$ASSERTIONS ON}
{$BOOLEVAL OFF}
{$DEBUGINFO ON}
{$EXTENDEDSYNTAX ON}
{$IMPORTEDDATA ON}
{$IOCHECKS ON}
{$LOCALSYMBOLS ON}
{$LONGSTRINGS ON}
{$OPENSTRINGS ON}
{$OPTIMIZATION ON}
{$OVERFLOWCHECKS OFF}
{$RANGECHECKS OFF}
{$REFERENCEINFO ON}
{$SAFEDIVIDE OFF}
{$STACKFRAMES OFF}
{$TYPEDADDRESS OFF}
{$VARSTRINGCHECKS ON}
{$WRITEABLECONST OFF}
{$MINENUMSIZE 1}
{$IMAGEBASE $400000}
{$IMPLICITBUILD OFF}

requires
  Borland.Delphi,
  Jedi.System;

contains
  JediDoc.System.InfoClasses in 'source\JediDoc.System.InfoClasses.pas';

[assembly: AssemblyTitle('JediDoc.Core')]
[assembly: AssemblyDescription('Jedi documentation tool core assembly')]
[assembly: AssemblyCompany('Project JEDI')]
[assembly: AssemblyProduct('JediDoc documentation tool')]
[assembly: AssemblyCopyright('Copyright © 2004, 2005 Project JEDI')]
[assembly: AssemblyTrademark('')]
[assembly: AssemblyCulture('')]
[assembly: AssemblyVersion('1.0.1.0')]
[assembly: AssemblyDelaySign(false)]
[assembly: AssemblyKeyFile('')]
[assembly: AssemblyKeyName('')]
[assembly: ComVisible(False)]

end.

--- NEW FILE: JediDoc.Console.bdsproj ---
(This appears to be a binary file; contents omitted.)

--- NEW FILE: JediDoc.Core.bdsproj ---
(This appears to be a binary file; contents omitted.)

--- NEW FILE: JediDoc.Tool.bdsproj ---
(This appears to be a binary file; contents omitted.)

--- NEW FILE: JediDoc.Xml.dpk ---
package JediDoc.Xml;

{$ALIGN 0}
{$ASSERTIONS ON}
{$BOOLEVAL OFF}
{$DEBUGINFO ON}
{$EXTENDEDSYNTAX ON}
{$IMPORTEDDATA ON}
{$IOCHECKS ON}
{$LOCALSYMBOLS ON}
{$LONGSTRINGS ON}
{$OPENSTRINGS ON}
{$OPTIMIZATION ON}
{$OVERFLOWCHECKS OFF}
{$RANGECHECKS OFF}
{$REFERENCEINFO ON}
{$SAFEDIVIDE OFF}
{$STACKFRAMES OFF}
{$TYPEDADDRESS OFF}
{$VARSTRINGCHECKS ON}
{$WRITEABLECONST OFF}
{$MINENUMSIZE 1}
{$IMAGEBASE $400000}
{$IMPLICITBUILD OFF}

requires
  Borland.Delphi,
  JediDoc.Core,
  System.XML,
  Jedi.IO;

contains
  JediDoc.System.Xml.Reflection in 'source\JediDoc.System.Xml.Reflection.pas',
  JediDoc.System.Xml.UnitDocGeneration in 'source\JediDoc.System.Xml.UnitDocGeneration.pas',
  JediDoc.System.Xml.AssemblyDocGeneration in 'source\JediDoc.System.Xml.AssemblyDocGeneration.pas';

[assembly: AssemblyTitle('JediDoc.Xml')]
[assembly: AssemblyDescription('Jedi documentation tool XML handling')]
[assembly: AssemblyCompany('Project JEDI')]
[assembly: AssemblyProduct('JediDoc documentation tool')]
[assembly: AssemblyCopyright('Copyright © 2004, 2005 Project JEDI')]
[assembly: AssemblyTrademark('')]
[assembly: AssemblyCulture('')]
[assembly: AssemblyVersion('1.0.1.0')]
[assembly: AssemblyDelaySign(false)]
[assembly: AssemblyKeyFile('')]
[assembly: AssemblyKeyName('')]
[assembly: ComVisible(False)]

end.

--- NEW FILE: JediDoc.Analysis.bdsproj ---
(This appears to be a binary file; contents omitted.)

--- NEW FILE: JediDoc.Xml.bdsproj ---
(This appears to be a binary file; contents omitted.)

--- NEW FILE: JediDoc.Console.dpr ---
program JediDoc.Console;

{$APPTYPE CONSOLE}

{%DelphiDotNetAssemblyCompiler '..\bin\JediDoc.Analysis.dll'}
{%DelphiDotNetAssemblyCompiler '..\bin\JediDoc.Core.dll'}
{%DelphiDotNetAssemblyCompiler '..\bin\JediDoc.Tool.dll'}
{%DelphiDotNetAssemblyCompiler '..\bin\JediDoc.Xml.dll'}

{$AUTOBOX ON}

uses
{$REGION 'uses'}
  JediDoc.System.Analysis,
  JediDoc.System.Console,
  JediDoc.System.InfoClasses,
  JediDoc.System.Project,
  JediDoc.System.Xml.AssemblyDocGeneration,
  JediDoc.System.Xml.Reflection,
  JediDoc.System.Xml.UnitDocGeneration,
  System.Collections,
  System.IO,
  System.Reflection,
  System.Runtime.InteropServices;
{$ENDREGION}

{$REGION 'Assembly attributes'}
[assembly: AssemblyTitle('JediDoc.Console')]
[assembly: AssemblyDescription('Jedi documentation command line tool')]
[assembly: AssemblyCompany('Project JEDI')]
[assembly: AssemblyProduct('JediDoc documentation tool')]
[assembly: AssemblyCopyright('Copyright © 2004, 2005 Project JEDI')]
[assembly: AssemblyTrademark('')]
[assembly: AssemblyCulture('')]
[assembly: AssemblyVersion('1.0.1.0')]
[assembly: AssemblyDelaySign(false)]
[assembly: AssemblyKeyFile('')]
[assembly: AssemblyKeyName('')]
[assembly: ComVisible(False)]
{$ENDREGION}

{$REGION 'Data'}
var
  docs: DocOverview;
  assyPath: string;
  xmlPath: string;
{$ENDREGION}

procedure Analyse;
begin
  Console.WriteLine('Analysis:');
  Console.WriteLine('  Items not in xml: {0}', DocAnalyzer.GetAssemblyOnlyElements(docs).Count);
  Console.WriteLine('  Items only in xml: {0}', DocAnalyzer.GetDocumentOnlyElements(docs).Count);
  Console.WriteLine;
end;

procedure AssemblyGeneration;
begin
  if not Settings.Quiet then
    Console.WriteLine('Generating assembly-based XML files...');
  AssemblyDocs.Generate(docs, assyPath);
end;

procedure DisplaySettings;
begin
  Console.WriteLine('Settings:');
  Console.Write('  Analyse? ');
  if Settings.ExecutionType and Settings.ExecutionTypes.Analyse = Settings.ExecutionTypes.Analyse then
    Console.WriteLine('yes')
  else
    Console.WriteLine('no');

  Console.Write('  Unit-based docs? ');
  if Settings.ExecutionType and Settings.ExecutionTypes.UnitGeneration = Settings.ExecutionTypes.UnitGeneration then
    Console.WriteLine('yes')
  else
    Console.WriteLine('no');

  Console.Write('  Assembly-based docs? ');
  if Settings.ExecutionType and Settings.ExecutionTypes.AssemblyGeneration =
      Settings.ExecutionTypes.AssemblyGeneration then
    Console.WriteLine('yes')
  else
    Console.WriteLine('no');

  Console.WriteLine;
end;

procedure ParseProject;
var
  enum: IEnumerator;
  hasFile: Boolean;
begin
  docs := DocOverview.Create;
  if not Settings.Quiet then
    Console.WriteLine('Processing assemblies...');
  enum := Settings.ProjectContents.Assemblies.GetFileEnumerator;
  hasFile := False;
  while enum.MoveNext do
  begin
    hasFile := True;
    if not Settings.Quiet then
      Console.WriteLine('  ' + Path.GetFileNameWithoutExtension(string(enum.Current)));
    docs.ProcessAssembly(string(enum.Current));
  end;
  if not hasFile then
  begin
    Console.WriteLine('ERROR: No assemblies assigned/found.');
    Halt(50);
  end;
  assyPath := Path.GetDirectoryName(Settings.ProjectContents.Assemblies[0]);

  if not Settings.Quiet then
    Console.WriteLine('Processing xml files...');
  enum := Settings.ProjectContents.XmlFiles.GetFileEnumerator;
  hasFile := False;
  while enum.MoveNext do
  begin
    hasFile := True;
    if not Settings.Quiet then
      Console.WriteLine('  ' + Path.GetFileNameWithoutExtension(string(enum.Current)));
    XmlReflector.ProcessXml(string(enum.Current), docs);
  end;
  if not hasFile then
  begin
    Console.WriteLine('ERROR: No xml files assigned/found.');
    Halt(50);
  end;
  xmlPath := Path.GetDirectoryName(Settings.ProjectContents.XmlFiles[0]);

  if not Settings.Quiet then
    Console.WriteLine;
end;

procedure SaveProject;
begin
  Console.WriteLine('Project files are not yet supported.');
  Halt(80);
end;

procedure UnitGeneration;
begin
  if not Settings.Quiet then
    Console.WriteLine('Generating unit-based XML files...');
  UnitDocs.Generate(docs, xmlPath, DocAnalyzer.GetChangedUnits(docs));
end;

begin
  Console.WriteLine('JediDoc Documentation tool 1.0');
  Console.WriteLine('Copyright (c) 2004, 2005 Project JEDI.');
  Console.WriteLine;
  Settings.ParseCommandLine;
  if not Settings.HelpShown then
  begin
    if not Settings.ArgumentDetected then
      Settings.ShowHelp
    else
    begin
      if not Settings.Quiet then
        DisplaySettings;
      if Settings.ExecutionType = Settings.ExecutionTypes.SaveProject then
        SaveProject
      else
      begin
        ParseProject;
        if Settings.ExecutionType and Settings.ExecutionTypes.Analyse = Settings.ExecutionTypes.Analyse then
          Analyse;
        if Settings.ExecutionType and Settings.ExecutionTypes.UnitGeneration =
            Settings.ExecutionTypes.UnitGeneration then
          UnitGeneration;
        if Settings.ExecutionType and Settings.ExecutionTypes.AssemblyGeneration =
            Settings.ExecutionTypes.AssemblyGeneration then
          AssemblyGeneration;
      end;
    end;
  end;
end.

--- NEW FILE: JediDoc.Tool.dpk ---
package JediDoc.Tool;

{$ALIGN 0}
{$ASSERTIONS ON}
{$BOOLEVAL OFF}
{$DEBUGINFO ON}
{$EXTENDEDSYNTAX ON}
{$IMPORTEDDATA ON}
{$IOCHECKS ON}
{$LOCALSYMBOLS ON}
{$LONGSTRINGS ON}
{$OPENSTRINGS ON}
{$OPTIMIZATION ON}
{$OVERFLOWCHECKS OFF}
{$RANGECHECKS OFF}
{$REFERENCEINFO ON}
{$SAFEDIVIDE OFF}
{$STACKFRAMES OFF}
{$TYPEDADDRESS OFF}
{$VARSTRINGCHECKS ON}
{$WRITEABLECONST OFF}
{$MINENUMSIZE 1}
{$IMAGEBASE $400000}
{$IMPLICITBUILD OFF}

requires
  Borland.Delphi,
  Jedi.System;

contains
  JediDoc.System.Project in 'source\JediDoc.System.Project.pas',
  JediDoc.System.Console in 'source\JediDoc.System.Console.pas';

[assembly: AssemblyTitle('JediDoc.Tool')]
[assembly: AssemblyDescription('Jedi documentation tool high level common classes')]
[assembly: AssemblyCompany('Project JEDI')]
[assembly: AssemblyProduct('JediDoc documentation tool')]
[assembly: AssemblyCopyright('Copyright © 2004, 2005 Project JEDI')]
[assembly: AssemblyTrademark('')]
[assembly: AssemblyCulture('')]
[assembly: AssemblyVersion('1.0.1.0')]
[assembly: AssemblyDelaySign(false)]
[assembly: AssemblyKeyFile('')]
[assembly: AssemblyKeyName('')]
[assembly: ComVisible(False)]

end.