pasdoc-main

[Pasdoc-main] [ pasdoc-Bugs-3101708 ] Warning during parsing files starting with BOM

[SourceForge.net <no...@so...>]

Bugs item #3101708, was opened at 2010-11-02 18:30
Message generated for change (Comment added) made by gskoczylas
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3101708&group_id=4213

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: parser
Group: 0.12.0
Status: Open
Resolution: None
Priority: 4
Private: No
Submitted By: Grzegorz Skoczylas (gskoczylas)
Assigned to: Nobody/Anonymous (nobody)
Summary: Warning during parsing files starting with BOM

Initial Comment:
During parsing files starting with BOM (http://goo.gl/mJKoU) PasDoc displays warning: Warning[2]: Error EPasDoc: Invalid character in Pascal input stream (at SourceFile.pas(1)) while parsing unit SourceFile.pas, continuing...

In this particular case source file is starting with the #$EF #$BB #$BF characteres.

----------------------------------------------------------------------

>Comment By: Grzegorz Skoczylas (gskoczylas)
Date: 2010-11-03 01:50

Message:
I have Delphi 2007 Professional

----------------------------------------------------------------------

Comment By: aguser (garrels)
Date: 2010-11-02 20:27

Message:
FPC, Delphi < 2009 or Delphi 2009+ .exe?

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3101708&group_id=4213

[Pasdoc-main] [ pasdoc-Bugs-3101708 ] Warning during parsing files starting with BOM

[SourceForge.net <no...@so...>]

Bugs item #3101708, was opened at 2010-11-02 18:30
Message generated for change (Comment added) made by garrels
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3101708&group_id=4213

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: parser
Group: 0.12.0
Status: Open
Resolution: None
Priority: 4
Private: No
Submitted By: Grzegorz Skoczylas (gskoczylas)
Assigned to: Nobody/Anonymous (nobody)
Summary: Warning during parsing files starting with BOM

Initial Comment:
During parsing files starting with BOM (http://goo.gl/mJKoU) PasDoc displays warning: Warning[2]: Error EPasDoc: Invalid character in Pascal input stream (at SourceFile.pas(1)) while parsing unit SourceFile.pas, continuing...

In this particular case source file is starting with the #$EF #$BB #$BF characteres.

----------------------------------------------------------------------

Comment By: aguser (garrels)
Date: 2010-11-02 20:27

Message:
FPC, Delphi < 2009 or Delphi 2009+ .exe?

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3101708&group_id=4213

[Pasdoc-main] [ pasdoc-Bugs-3101708 ] Warning during parsing files starting with BOM

[SourceForge.net <no...@so...>]

Bugs item #3101708, was opened at 2010-11-02 18:30
Message generated for change (Settings changed) made by gskoczylas
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3101708&group_id=4213

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: parser
Group: 0.12.0
Status: Open
Resolution: None
>Priority: 4
Private: No
Submitted By: Grzegorz Skoczylas (gskoczylas)
Assigned to: Nobody/Anonymous (nobody)
Summary: Warning during parsing files starting with BOM

Initial Comment:
During parsing files starting with BOM (http://goo.gl/mJKoU) PasDoc displays warning: Warning[2]: Error EPasDoc: Invalid character in Pascal input stream (at SourceFile.pas(1)) while parsing unit SourceFile.pas, continuing...

In this particular case source file is starting with the #$EF #$BB #$BF characteres.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3101708&group_id=4213

[Pasdoc-main] [ pasdoc-Bugs-3101708 ] Warning during parsing files starting with BOM

[SourceForge.net <no...@so...>]

Bugs item #3101708, was opened at 2010-11-02 18:30
Message generated for change (Tracker Item Submitted) made by gskoczylas
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3101708&group_id=4213

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: parser
Group: 0.12.0
Status: Open
Resolution: None
Priority: 5
Private: No
Submitted By: Grzegorz Skoczylas (gskoczylas)
Assigned to: Nobody/Anonymous (nobody)
Summary: Warning during parsing files starting with BOM

Initial Comment:
During parsing files starting with BOM (http://goo.gl/mJKoU) PasDoc displays warning: Warning[2]: Error EPasDoc: Invalid character in Pascal input stream (at SourceFile.pas(1)) while parsing unit SourceFile.pas, continuing...

In this particular case source file is starting with the #$EF #$BB #$BF characteres.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3101708&group_id=4213

[Pasdoc-main] [ pasdoc-Bugs-3101524 ] Somtimes log contains strage characters

[SourceForge.net <no...@so...>]

Bugs item #3101524, was opened at 2010-11-02 12:34
Message generated for change (Comment added) made by kambi
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3101524&group_id=4213

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: 0.12.0
Status: Pending
Resolution: None
Priority: 5
Private: No
Submitted By: Nobody/Anonymous (nobody)
Assigned to: Michalis Kamburelis (kambi)
Summary: Somtimes log contains strage characters

Initial Comment:
I'm using PasDoc for creating either HTML or CHM documentation. Whem I'm creating HTML documentation, the PasDoc's log is correct. But when I'm creating CHM documentation, then log contains strange characers.

My commandline for HTML documentation:
P:\PasDoc\bin\pasdoc.exe --include=. --output p:\Huzar\Doc\doc\ --write-uses-list --title "Huzar Tools" --use-tipue-search --marker : --language pl.cp1250 --format html --full-link --cache-dir p:\Huzar\Doc\doc.cache --implicit-visibility implicit --graphviz-classes --link-gv-classes png *.pas >pasdoc.log

My commandline for CHM documentation:
P:\PasDoc\bin\pasdoc.exe --include=. --output p:\Huzar\Doc\chm\ --write-uses-list --title "Huzar Tools" --use-tipue-search --marker : --language pl.cp1250 --format htmlhelp --full-link --cache-dir p:\Huzar\Doc\chm.cache --name "Huzar Software" --implicit-visibility implicit --graphviz-classes --link-gv-classes png *.pas >pasdoc.log



----------------------------------------------------------------------

>Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-02 17:27

Message:
Looking more carefully at your command-line, I realized that you use
different cache directories for html and htmlhelp: 
- p:\Huzar\Doc\doc.cache for html
- p:\Huzar\Doc\chm.cache for htmlhelp

This is not needed (you can use the same cache directory for various
output formats, it's guaranteed to work Ok. It's even adviced, to take most
advantage of cache speedup).

This also kind-of confirms my previous suggestion. Inside
p:\Huzar\Doc\chm.cache you probably have old cache files, from previous
pasdoc version. You should remove them. Your html cache uses different
directory, that seemingly had no old cache files.

----------------------------------------------------------------------

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-02 12:51

Message:
Hm, the strange characters in log appear because you have strange content
in your cache files. The real problem is that our cache reading fails, with
"Warning[2]: Error ESerializedException: Tried loading unknown class"
(followed by a nonsense class name with strange characters).

Do you maybe have cache files from older PasDoc version inside
p:\Huzar\Doc\doc.cache? If yes, then you should delete them. Cache files
between PasDoc releases are incompatible. It may be a pure coincidence that
html generation succeeds without any strange errors. (Admittedly, we should
resolve it better, by placing a nice version marker in cache files and
simply automatically handling this case in pasdoc.)

I tried your commands on PasDoc files, and evereything seems to work here,
if I start from a clear (no files) cache directory:

cd trunk/source/component/
pasdoc --include=. --output /tmp/ --write-uses-list --title "Huzar Tools"
--use-tipue-search --marker : --language pl.cp1250 --format html
--full-link --cache-dir /tmp/cache --implicit-visibility implicit
--graphviz-classes --link-gv-classes png *.pas > pasdoc.log
pasdoc --include=. --output /tmp/ --write-uses-list --title "Huzar Tools"
--use-tipue-search --marker : --language pl.cp1250 --format htmlhelp
--full-link --cache-dir /tmp/cache --name "Huzar Software"
--implicit-visibility implicit --graphviz-classes --link-gv-classes png
*.pas > pasdoc.log

So
1. try deleting all cache files from p:\Huzar\Doc\doc.cache
2. if this doesn't help, you'll have to provide your source files, so that
we can reproduce the problem. Preferably, not your full source code, but a
sample unit / part of the unit that still causes the bug.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3101524&group_id=4213

[Pasdoc-main] [ pasdoc-Bugs-3101524 ] Somtimes log contains strage characters

[SourceForge.net <no...@so...>]

Bugs item #3101524, was opened at 2010-11-02 12:34
Message generated for change (Comment added) made by kambi
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3101524&group_id=4213

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: 0.12.0
>Status: Pending
Resolution: None
Priority: 5
Private: No
Submitted By: Nobody/Anonymous (nobody)
>Assigned to: Michalis Kamburelis (kambi)
Summary: Somtimes log contains strage characters

Initial Comment:
I'm using PasDoc for creating either HTML or CHM documentation. Whem I'm creating HTML documentation, the PasDoc's log is correct. But when I'm creating CHM documentation, then log contains strange characers.

My commandline for HTML documentation:
P:\PasDoc\bin\pasdoc.exe --include=. --output p:\Huzar\Doc\doc\ --write-uses-list --title "Huzar Tools" --use-tipue-search --marker : --language pl.cp1250 --format html --full-link --cache-dir p:\Huzar\Doc\doc.cache --implicit-visibility implicit --graphviz-classes --link-gv-classes png *.pas >pasdoc.log

My commandline for CHM documentation:
P:\PasDoc\bin\pasdoc.exe --include=. --output p:\Huzar\Doc\chm\ --write-uses-list --title "Huzar Tools" --use-tipue-search --marker : --language pl.cp1250 --format htmlhelp --full-link --cache-dir p:\Huzar\Doc\chm.cache --name "Huzar Software" --implicit-visibility implicit --graphviz-classes --link-gv-classes png *.pas >pasdoc.log



----------------------------------------------------------------------

>Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-02 12:51

Message:
Hm, the strange characters in log appear because you have strange content
in your cache files. The real problem is that our cache reading fails, with
"Warning[2]: Error ESerializedException: Tried loading unknown class"
(followed by a nonsense class name with strange characters).

Do you maybe have cache files from older PasDoc version inside
p:\Huzar\Doc\doc.cache? If yes, then you should delete them. Cache files
between PasDoc releases are incompatible. It may be a pure coincidence that
html generation succeeds without any strange errors. (Admittedly, we should
resolve it better, by placing a nice version marker in cache files and
simply automatically handling this case in pasdoc.)

I tried your commands on PasDoc files, and evereything seems to work here,
if I start from a clear (no files) cache directory:

cd trunk/source/component/
pasdoc --include=. --output /tmp/ --write-uses-list --title "Huzar Tools"
--use-tipue-search --marker : --language pl.cp1250 --format html
--full-link --cache-dir /tmp/cache --implicit-visibility implicit
--graphviz-classes --link-gv-classes png *.pas > pasdoc.log
pasdoc --include=. --output /tmp/ --write-uses-list --title "Huzar Tools"
--use-tipue-search --marker : --language pl.cp1250 --format htmlhelp
--full-link --cache-dir /tmp/cache --name "Huzar Software"
--implicit-visibility implicit --graphviz-classes --link-gv-classes png
*.pas > pasdoc.log

So
1. try deleting all cache files from p:\Huzar\Doc\doc.cache
2. if this doesn't help, you'll have to provide your source files, so that
we can reproduce the problem. Preferably, not your full source code, but a
sample unit / part of the unit that still causes the bug.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3101524&group_id=4213

[Pasdoc-main] [ pasdoc-Bugs-3101524 ] Somtimes log contains strage characters

[SourceForge.net <no...@so...>]

Bugs item #3101524, was opened at 2010-11-02 11:34
Message generated for change (Tracker Item Submitted) made by nobody
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3101524&group_id=4213

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: 0.12.0
Status: Open
Resolution: None
Priority: 5
Private: No
Submitted By: Nobody/Anonymous (nobody)
Assigned to: Nobody/Anonymous (nobody)
Summary: Somtimes log contains strage characters

Initial Comment:
I'm using PasDoc for creating either HTML or CHM documentation. Whem I'm creating HTML documentation, the PasDoc's log is correct. But when I'm creating CHM documentation, then log contains strange characers.

My commandline for HTML documentation:
P:\PasDoc\bin\pasdoc.exe --include=. --output p:\Huzar\Doc\doc\ --write-uses-list --title "Huzar Tools" --use-tipue-search --marker : --language pl.cp1250 --format html --full-link --cache-dir p:\Huzar\Doc\doc.cache --implicit-visibility implicit --graphviz-classes --link-gv-classes png *.pas >pasdoc.log

My commandline for CHM documentation:
P:\PasDoc\bin\pasdoc.exe --include=. --output p:\Huzar\Doc\chm\ --write-uses-list --title "Huzar Tools" --use-tipue-search --marker : --language pl.cp1250 --format htmlhelp --full-link --cache-dir p:\Huzar\Doc\chm.cache --name "Huzar Software" --implicit-visibility implicit --graphviz-classes --link-gv-classes png *.pas >pasdoc.log



----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3101524&group_id=4213

Re: [Pasdoc-main] PasDoc 0.12.0 released!

[Michalis K. <mic...@gm...>]

Michalis Kamburelis wrote:
> I'll submit a news about this release to SourceForge, freshmeat and
> Lazarus forums.

It's all done now. News are on
 - https://sourceforge.net/news/?group_id=4213
 - http://freshmeat.net/projects/pasdoc/ (will be visible soon, once
accepted)
 - http://lazarus.freepascal.org/index.php/topic,10972.0.html (on the
main page right now, http://lazarus.freepascal.org/)
 - I also added us to
http://wiki.lazarus.freepascal.org/Projects_using_Lazarus#PasDoc

Michalis

[Pasdoc-main] PasDoc 0.12.0 released!

[Michalis K. <mic...@gm...>]

It was a dark, stormy night. Little Jack woke up to the sound of a wolf
howling in the distance. He looked outside of the window, and in a
sudden flash of lighting saw a grotesque silhouette. It was... yes, it
was PasDoc 0.12.0 getting released!

Here you go. On a Halloween night, our grim PasDoc 0.12.0 release is
done :) Sorry for a little delay, I planned to do this yesterday.

You can download binary and source packages from the usual place:

  https://sourceforge.net/projects/pasdoc/files/

For the most popular platforms, the big green "Download now" button at
the top of the page points to the package you want to get. Look lower,
at the "PasDoc xxx/0.12.0/" directories, for other files. Like I
mentioned in a previous mail, you're welcome to provide binaries for
other targets, if you want to see 0.12.0 release for them too.

For a demo, look for example at our autodoc, on

  http://pasdoc.sipsolutions.net/PasDocAutoDoc

I'll submit a news about this release to SourceForge, freshmeat and
Lazarus forums. You're most welcome to advertise this release on other
Pascal-related sites/forums/etc. that you know (you may of course use
the text of this email, in particular the list of changes below, if you
want to).

The list of changes (from the ChangeLog file) follows:

* Class Hierarchy diagrams are more complete, because PasDoc knows
  about hierarchy of the standard ObjectPascal classes.
  You can also extend this by --external-class-hierarchy= option.
  See [http://pasdoc.sipsolutions.net/ExternalClassHierarchy]
  (by Michalis)
* Support for Delphi Unicode compilers,
  improve processing speed by using TBufferedStream,
  parsing some new Delphi features (like "deprecated 'string'")
  (by Arno Garrels)
* Many improvements to pasdoc_gui:
  * Better adjusts to various themes and font sizes, on all platforms
  * More intuitive UI: "Generate" button on the left,
    "Output directory" on the "Options" tab and filled by default
    with temp directory, and more.
  * xdg-open is used on Unix now.
  (by Michalis Kamburelis)
+ --ignore-leading= option,
  see [http://pasdoc.sipsolutions.net/IgnoreLeadingOption]
  (by <tobigun at users.sourceforge.net>)
* Translations:
  * Russian localization updated by <werewolf_ at users.sourceforge.net>
  * Simplified Chinese Translation updated by Liu Da
  * Czech translation by Rene Mihula
  * Polish translation updated (by anonymous)
  * Bulgarian translation by Andrew Andreev
  * French translation updated (and utf-8 version added)
    by Yann Merignac
  (see [http://pasdoc.sipsolutions.net/OutputLanguage])

Have fun!
Michalis

[Pasdoc-main] PasDoc 0.12.0 release tomorrow

[Michalis K. <mic...@gm...>]

Hi,

I think we're ready for 0.12.0 release :) I did everything I wanted for
0.12.0, and checked that tests pass (at least on Linux i386 with FPC
2.4.0). If nothing unexpected will happen, I think we're ready for
release tomorrow (that is, Saturday).

I'll handle the Linux/i386, Linux/x86_64, Windows/i386 and MacOSX/i386
targets. If you want to help and make a 0.12.0 release available for
other targets, you're most welcome: at the basis, just compile `pasdoc`
by the "make clean build-fpc-default" command inside the main directory,
and make the binary available to me (email to me, or put somewhere and
send me a link etc.). If you want to do more, you can even prepare ready
tar.gz/zip release by "make dist-<os/arch>", you can check various
automatic tests, and you can compile pasdoc_gui as well. Everything is
documented on http://pasdoc.sipsolutions.net/ReleaseMaking in "Compile
and test all releases" section.

Of course all testing is welcome at this point (as always). Testing
PasDoc compilation with various compilers is of course also welcome.

Michalis

[Pasdoc-main] More complete "Class Hierarchy" (by knowing "external" class hierarchy)

[Michalis K. <mic...@gm...>]

I implemented in trunk a fix/feature (depends how you look at it :) )
called "external class hierarchy". The idea is that the "Class
Hierarchy" generated by PasDoc (both in HTML page and for GraphViz
graph) was sometimes not perfect, because PasDoc doesn't know about the
hierarchy of classes defined outside of your source files.

For example: suppose you have classes A, B descending from TObject, and
classes C, D descending from Exception. Your source code contains
classes A, B, C, D, but does not contain definitions for standard
TObject and Exception classes. So PasDoc was showing them as

TObject
|- A
|- B
Exception
|- C
|- D

That is, PasDoc had no idea that class Exception descends (directly!)
from TObject.

Right now, this will be shown correctly as

TObject
|- A
|- B
|- Exception
  |- C
  |- D

A screenshot showing the two outputs side-by-side is probably better
than my ascii art :), attaching.

We now provide PasDoc with built-in knowledge of hierarchy of the common
RTL/component classes. This is encoded in
source/component/external_class_hierarchy.txt file in SVN (and processed
to .inc file and embedded in executable, just like our CSS file). This
hierarchy is taken from FreePascal RTL/FCL units, see script
source/tools/fpc_sources_parse_for_external_class_hierarchy.sh . Format
is a trivial text file with lines TChildClass=TParentName.

You can also provide your own file with class hierarchy by
--external-class-hierarchy=file.txt command-line option.

The docs are on

http://pasdoc.sipsolutions.net/ExternalClassHierarchy#preview

Everyone is welcome to share (you can paste it to that wiki page, for
example) the class hierarchy made specially for other libraries, like
Delphi RTL (if the differences between Delphi and FPC RTL will be too
much nuisance), VCL, or just any other library.

For the future:

- Implementation of --external-class-hierarchy= may be improved one day
to be able to take a dot (GraphViz) file. This would allow you to 100%
automatically generate a class hierarchy for your library, by existing
--graphviz-classes option, that can be later used by others by
--external-class-hierarchy= option. If / when I will implement it
depends on the success of this feature :), unless someone has ready
patch of course.

Michalis

Re: [Pasdoc-main] PasDoc 0.12.0 release next week, and decisions for PasDoc2 branch

[Michalis K. <mic...@gm...>]

Michalis Kamburelis wrote:
> Right now, the end result of PasDoc2 branch:

Reading it back, maybe it was too harsh. After all, some parts of
PasDoc2 branch were applied.

My main point was that I see many bugs in PasDoc2 branch (breaking not
only post-D7 features), which I mentioned many times, and I don't see
them getting fixed. I'm all after blaming it on the lack of time of
everyone, and closing this discussion.

Michalis

Re: [Pasdoc-main] PasDoc 0.12.0 release next week, and decisions for PasDoc2 branch

[Michalis K. <mic...@gm...>]

Hans-Peter Diettrich wrote:
>> See the mail at the beginning of this thread, where I start with
>> mentioning which tests fail.
> 
> All tests with post-D7 syntax will fail, of course, because I removed 
> all new syntax elements from the parser. I don't consider such files 
> valid code, for now.

A lot of stuff broken in PasDoc2 branch doesn't have any relation to
post-Delphi7 features. Just read the mails where I point out which tests
fail, and stop covering behind non-existing issues. Some examples (once
again): pasdoc parsing its own code (while pasdoc source doesn't use
post-D7 features, yet they fail around @orderedlist and "bad Add mode"),
ok_back_comment (//< comments), ok_vorbisfile (fpc macros).

And, a second note: you removed support for some post-D7 features,
because you considered the code hacky, and then you say you wait for
some specifications what to do next. Well, here's how things are
supposed to work: if you remove some code, then be prepared to know how
to replace it with something better. You are responsible for doing a
better design and proving that it works. You may get some help from
others, but not until I can see that you bring some advantages --- in
this case, you made some changes that I consider ugly (mixing generators
and scanners knowledge) and you introduced bugs (*not* only at post-D7
features).

Right now, the end result of PasDoc2 branch:
1. You broke some post-D7 features (which I can accept, but only as an
intermediate step to implementing them even better),
2. You broke some stuff not related to post-D7 features (which is a
verifiable fact by simply running the testsuite, yet you somehow manage
to ignore it in your emails).

Sorry if it sounds harsh, but that's the way I see it. A single commit
from you to PasDoc2 branch, attempting to fix at least a single problem
there, may change my mind. Another mail, where you repeat that you wait
for someone else to design a better model, and ignore actual bugs that
are pointed out to you, will not help in advancing the PasDoc2 branch.

Michalis

Re: [Pasdoc-main] PasDoc 0.12.0 release next week, and decisions for PasDoc2 branch

[Hans-Peter D. <DrD...@ao...>]

Michalis Kamburelis schrieb:
> Hans-Peter Diettrich wrote:
>>> Some of them are
>>> range check errors when parsing valid code,
>> I didn't come across such errors, and wasn't informed about such situations.
> 
> See the mail at the beginning of this thread, where I start with
> mentioning which tests fail.

All tests with post-D7 syntax will fail, of course, because I removed 
all new syntax elements from the parser. I don't consider such files 
valid code, for now.

Once provisions for nested declarations have been added to PasDoc, the 
parser has to be reorganized accordingly, and *after all that* the new 
syntax elements can be added, and possibly also parsing of the 
implementation part.

DoDi

Re: [Pasdoc-main] Support for Delphi Unicode compilers, and more changes from Arno Garrels

[Michalis K. <mic...@gm...>]

I wrote:
> I just merged to pasdoc trunk many changes from Arno Garrels.

Update: More patches from Arno Garrels were committed, and he is now a
member of PasDoc developers :) His SourceForge username is "garrels".

Michalis

Re: [Pasdoc-main] PasDoc 0.12.0 release next week, and decisions for PasDoc2 branch

[Michalis K. <mic...@gm...>]

Hans-Peter Diettrich wrote:
>> Some of them are
>> range check errors when parsing valid code,
> 
> I didn't come across such errors, and wasn't informed about such situations.

See the mail at the beginning of this thread, where I start with
mentioning which tests fail. And see the referenced mails two years ago.

https://sourceforge.net/mailarchive/message.php?msg_name=4CC36F84.9060207%40gmail.com

https://sourceforge.net/mailarchive/message.php?msg_id=4883125E.2050809%40gmail.com

https://sourceforge.net/mailarchive/message.php?msg_name=492059DE.6060607%40gmail.com

Michalis

Re: [Pasdoc-main] PasDoc 0.12.0 release next week, and decisions for PasDoc2 branch

[Hans-Peter D. <DrD...@ao...>]

Michalis Kamburelis schrieb:

> My objections were about bugs in your PasDoc2 branch code, bugs that
> didn't exist in original trunk code.

Let me try to separate the modifications:

> I honestly don't know what
> "specifications" or "actions" on my part you were waiting for. These
> bugs didn't exist in the trunk code in the first place.

Some hacks have been removed, that had been introduced in trunk for 
parsing new Delphi syntax, but without according handling of the 
syntactic constructs. The consequential errors indicate the incapability 
of handling such post-D7 constructs, due to limitations in the PasDoc 
tree model. Also a specification of the new Delphi grammar is required, 
not available to me at that time.

> Some of them are
> range check errors when parsing valid code,

I didn't come across such errors, and wasn't informed about such situations.

> and I can't imagine how any
> "specification" or (more) architectural changes of pasdoc would help
> here.

The PasDoc model does not include nested declarations, according to new 
Delph syntax; e.g. type, var and const declarations inside class 
declarations.

> Bugs need to be fixed, and when you introduce them --- it's
> usually your job to fix them.

When a program says "done" without doing anything, then I consider this 
fake behaviour a bug.


> I understand that you didn't have time to do it. It's Ok. Neither did I.
> Just don't blame it on waiting for some action on my part, something
> that I had no idea about.

Sorry for the lack of communication. You should have understood the 
implications of the new Delphi syntax, and their impact on the PasDoc 
tree model, in both parser and generator code. The inappropriate tree 
structure also prevents handling of local (nested) procedures, that's 
why I could not extend the parser to also process implementation sections.



>> We differ in many ideas, how things should be made working. I've 
>> implemented and tested my approach(es) for feasability, but only on the 
>> small scale, i.e. the implementation may not work yet in certain cases. 
> 
> Your implementation doesn't work.

It works with Delphi syntax up to D7.

> And instead of fixing the bugs, you
> only respond with emails talking how "the model is inapplicable" or
> such.

Right. Please provide a tree model that can deal with nested 
declarations, or let somebody else provide it.


> You seem to demand from me some big decision, where I don't see a need
> to make one.

Sorry that I could not make it more clear to you :-(

 > The "plan" is to keep PasDoc working, parsing Pascal
> sources with latest Delphi and FPC features, and make output useful.
> Whoa, that was deep.

Then add wings to PasDoc first, before you ask anybody else to make it fly.

> Everything may be changed (alternative parser, PasDoc_Items tree, etc.)
> when it's needed. Just do it as gradually as possible, and don't
> introduce bugs (or at least fix them afterwards).

It was not my task to modify the tree model.

>> Does there exist any documentation of the (current/intended) tree 
>> structure, in general and in implementation details? I definitely 
>> deserve some concrete material, that could convince me to resume working 
>> on PasDoc.
>>
> 
> The autodoc http://pasdoc.sipsolutions.net/PasDocAutoDoc is our
> documentation.

You are kidding. That "documentation" says nothing about the existing 
tree structure, nor about the handling of nested declarations, nor about 
the language syntax that is or should be implemented.

DoDi

Re: [Pasdoc-main] PasDoc 0.12.0 release next week, and decisions for PasDoc2 branch

[Michalis K. <mic...@gm...>]

Hans-Peter Diettrich wrote:
> Michalis Kamburelis schrieb:
> 
>> Quick test showed that the version from the PasDoc2 branch still fails
>> on a lot of testcases. This was mentioned e.g. here
>> https://sourceforge.net/mailarchive/message.php?msg_id=4883125E.2050809%40gmail.com
>> , and many issues are still not fixed.
> 
> Some "bugs" can not be fixed without a deep change to the PasDoc data 
> structures, so that e.g. nested declaration sections (in class 
> declarations) can be handled at all. I've been waiting for according 
> specifications or actions from your part, but nothing happened. So I 
> only could do some more "cosmetic" changes to the existing model and 
> generators, as far as I could figure out how the existing model was 
> intended to work.

My objections were about bugs in your PasDoc2 branch code, bugs that
didn't exist in original trunk code. I honestly don't know what
"specifications" or "actions" on my part you were waiting for. These
bugs didn't exist in the trunk code in the first place. Some of them are
range check errors when parsing valid code, and I can't imagine how any
"specification" or (more) architectural changes of pasdoc would help
here. Bugs need to be fixed, and when you introduce them --- it's
usually your job to fix them.

I understand that you didn't have time to do it. It's Ok. Neither did I.
Just don't blame it on waiting for some action on my part, something
that I had no idea about.

> Another observation was the source code pollution, caused by 
> documentation comments in e.g. class declarations. Such comments IMO 
> should be moved into the implementation part, what would require to 
> parse that part as well. That's why I concentrated on external 
> description files, that are and remain applicable even after changes to 
> the source code structure, and do not rely so much on extensions to the 
> various language versions (Delphi, FPC...). 

This is an old question, whether documentation should go to the
interface, and thus "pollute" the interface. In my opinion yes, because
this makes interface more useful. But I agree that it's a matter of
taste, I wrote my opinion about this on
http://pasdoc.sipsolutions.net/MichalisKamburelis#Should_documentation_be_placed_inside_units_interface.2C_or_in_separate_files_.3F

>Then parsers can be 
> implemented quite independently from the internal PasDoc model, e.g. can 
> be borrowed from FPC or Lazarus. Their output would provide an 
> declaration tree, or a flat list of qualified identifiers, that can be 
> matched with any (applicable!) PasDoc tree model, and/or with external 
> topic files. The existing PasDoc model was inapplicable, up to the time 
> when I left the project.

So you have to parse the code anyway, in any approach (comments in the
interface, or implementation, or external files). The reasons for using
our own parser were, and still are, that

1. At least fcl-passrc still doesn't offer all the features. There were
many improvements recently, but still e.g. FPC macros are not supported.
Not to mention that latest Delphi's features (which are the main lack of
pasdoc according to bugreports) aren't probably implemented there
either, as FPC doesn't handle many of them.

2. Noone implemented it. Using fcl-passrc, or any other open parser (I
remember at least JEDI parser mentioned in the past) is always a welcome
option. But you have to prove that it works (on testsuite, on
autodoc). Right now, since we know that fcl-passrc is not perfect,
implementing it as an alternative parser (that can be used instead of
the current one, activated e.g. by command-line option) would probably
be the right way to go.

Whether PasDoc_Items model should be upgraded for new Delphi features is
IMO orthogonal to the fact that parser should be upgraded / replaced.
I'm all after upgrading the PasDoc_Items model, as long as it's done in
a way that can be applied and doesn't break stuff that is already
working correctly.

> I just received a note from another contributor, who wanted to provide 
> Unicode-related improvements. He seems to be blocked by your many recent 
> changes to the trunk. Can you provide a roadmap, about the intended 
> changes, and how other activities could fit into the revised project?

Looks like I also received a mail from him, looks like he's talking to
us in parallel. And his work is completely applied to trunk now, see my
mail "Support for Delphi Unicode compilers" a second ago.

Although I didn't hear from him about being blocked by my changes. And
it would be strange, as we had 2 years of inactivity (except applying
small patches and translations), followed by changes mostly to
pasdoc_gui in recent days. I honestly can't see how I could do *less*
work, so I really can't imagine how I'm blocking someone. The pasdoc
architecture stayed virtually untouched for 2 years, plenty of time if
someone wants to provide patches. And many people did, and I tried to
apply them quickly --- as long as I could see that the change is good
and code compiles and works.

> 
> We differ in many ideas, how things should be made working. I've 
> implemented and tested my approach(es) for feasability, but only on the 
> small scale, i.e. the implementation may not work yet in certain cases. 

Your implementation doesn't work. And instead of fixing the bugs, you
only respond with emails talking how "the model is inapplicable" or
such. I don't know how you tested your code, but it *doesn't work*.
Autodoc fails, testsuite fails. These both tests were available to you
in pasdoc SVN, and mentioned to you many times. See previous mails for
details.

> But unless decisions are made, how things *shall* work in a future 
> PasDoc version, I consider even minor bugfixes to the existing code 
> nothing but a waste of time.

You seem to demand from me some big decision, where I don't see a need
to make one. The "plan" is to keep PasDoc working, parsing Pascal
sources with latest Delphi and FPC features, and make output useful.
Whoa, that was deep.

Everything may be changed (alternative parser, PasDoc_Items tree, etc.)
when it's needed. Just do it as gradually as possible, and don't
introduce bugs (or at least fix them afterwards).

> 
> Does there exist any documentation of the (current/intended) tree 
> structure, in general and in implementation details? I definitely 
> deserve some concrete material, that could convince me to resume working 
> on PasDoc.
> 

The autodoc http://pasdoc.sipsolutions.net/PasDocAutoDoc is our
documentation.

Michalis

[Pasdoc-main] Support for Delphi Unicode compilers, and more changes from Arno Garrels

[Michalis K. <mic...@gm...>]

I just merged to pasdoc trunk many changes from Arno Garrels.

They add support for Delphi Unicode compilers, improve processing speed
by using TBufferedStream, add small fixes to parsing new Delphi features
(see ok_procedural_const.pas and ok_deprecated_const_string.pas
testcases), cleanup our language definitions by moving everything into
separate files in lang/ subdirectory, and probably some more stuff that
I forgot :) See SVN logs for details.

They also add a Delphi GUI application (tested with Delphi 7- XE), which
is committed to source/delphi_gui/ directory. For pasdoc releases, we'll
still use Lazarus gui (in source/gui/), because we need to be
cross-platform (and Michalis doesn't own Delphi since quite a long
time...). But it looks like Delphi version of pasdoc_gui is worked on by
many people, so hey --- here you go, you can develop it in pasdoc SVN :)
I'm all for a little healthy competition between Lazarus and Delphi
pasdoc_gui versions :) Of course, when possible, it would also be nice
to keep their features at synch.

Michalis

Re: [Pasdoc-main] PasDoc 0.12.0 release next week, and decisions for PasDoc2 branch

[Hans-Peter D. <DrD...@ao...>]

Michalis Kamburelis schrieb:

> Quick test showed that the version from the PasDoc2 branch still fails
> on a lot of testcases. This was mentioned e.g. here
> https://sourceforge.net/mailarchive/message.php?msg_id=4883125E.2050809%40gmail.com
> , and many issues are still not fixed.

Some "bugs" can not be fixed without a deep change to the PasDoc data 
structures, so that e.g. nested declaration sections (in class 
declarations) can be handled at all. I've been waiting for according 
specifications or actions from your part, but nothing happened. So I 
only could do some more "cosmetic" changes to the existing model and 
generators, as far as I could figure out how the existing model was 
intended to work.

Another observation was the source code pollution, caused by 
documentation comments in e.g. class declarations. Such comments IMO 
should be moved into the implementation part, what would require to 
parse that part as well. That's why I concentrated on external 
description files, that are and remain applicable even after changes to 
the source code structure, and do not rely so much on extensions to the 
various language versions (Delphi, FPC...). Then parsers can be 
implemented quite independently from the internal PasDoc model, e.g. can 
be borrowed from FPC or Lazarus. Their output would provide an 
declaration tree, or a flat list of qualified identifiers, that can be 
matched with any (applicable!) PasDoc tree model, and/or with external 
topic files. The existing PasDoc model was inapplicable, up to the time 
when I left the project.


> The really large architectural stuff is not really touched yet, so the
> real and big decisions are still ahead.
> 
> Help in fixing PasDoc2 branch would be helpful. Please let me do the
> final merging to trunk/, but everyone feel welcome to make fixes to
> PasDoc2 branch to fix the issues. (Just make sure you do "svn up" often,
> to synch with my own changes, as I plan to work intensively on this
> within few next days.)

I just received a note from another contributor, who wanted to provide 
Unicode-related improvements. He seems to be blocked by your many recent 
changes to the trunk. Can you provide a roadmap, about the intended 
changes, and how other activities could fit into the revised project?


> Also, a documentation of user-visible improvements in PasDoc2 branch
> would be helpful (I mean, a nice wiki page with examples, something
> ready to show to users). The PasDoc2 branch supposedly includes
> @groupbegin/end support, but I can't really test it since even autodoc
> fails. And looking at code --- it's different than the planned usage on
> http://pasdoc.sipsolutions.net/MichalisKamburelis#Support_for_groups_of_items
> . So I'm not even sure if I want @groupbegin/end implemented this way,
> and I don't know of other user-visible improvements from PasDoc2 branch.

We differ in many ideas, how things should be made working. I've 
implemented and tested my approach(es) for feasability, but only on the 
small scale, i.e. the implementation may not work yet in certain cases. 
But unless decisions are made, how things *shall* work in a future 
PasDoc version, I consider even minor bugfixes to the existing code 
nothing but a waste of time.


> I definitely want to decide before the 0.12.0 release what to do with
> PasDoc2 branch. Merge what (if any) should be still merged, and
> semi-officially "close" the PasDoc2 branch as a finished work. The issue
> with applying PasDoc2 branch is hanging over us for ~2 years, so some
> decision needs to be made, and then the new development should focus
> again on trunk branch.

Does there exist any documentation of the (current/intended) tree 
structure, in general and in implementation details? I definitely 
deserve some concrete material, that could convince me to resume working 
on PasDoc.

DoDi

[Pasdoc-main] --spell-check command-line option

[Michalis K. <mic...@gm...>]

The new --spell-check option is a slightly better alternative for old
--aspell=LANGUAGE. It's equivalent to using --aspell with a language
code derived from the --language command-line parameter.

So, simply put, --spell-check simply activates spell-checking. It works
exactly like before, except it cooperates now with what you specified by
the --language, and now you don't have to care about your Aspell
language code. This magic was already done by spell-checking in
pasdoc_gui, now it's comfortable also from command-line.

You can also use --aspell with empty language code, but this looks ugly
on the command-line, and is the reason why I introduced a new option
--spell-check.

Docs on http://pasdoc.sipsolutions.net/SpellChecking

Michalis

[Pasdoc-main] pasdoc_gui - many improvements

[Michalis K. <mic...@gm...>]

I made a lot of small improvements to pasdoc_gui in the last days.
I think for the 0.12.0 release we can put pasdoc_gui binary in normal
bin/ subdirectory (it was in that scary experimental/ subdirectory in
0.11.0 release :)

Testing binaries for Linux and Windows (i386) can be downloaded from

  http://michalis.ii.uni.wroc.pl/~michalis/tmp/pasdoc-0.12.0-snaps/

(With debug info, that's why they are a little large.)

The short introduction to pasdoc_gui usage is on
http://pasdoc.sipsolutions.net/PasDocGui , slightly updated for 0.12.0
release.

Some list of changes:

- Various anchor and autosizing improvements, hopefully it now really
works with various themes and font sizes.

- I wanted to make the most important controls more visible. For the
most basic usage, the user only cares about checking "output directory",
adding his "source files" and then clicking on generate. So 1. "output
directory" is now on main "Options" tab and is even filled with
GetTempDir for starters, 2. "source files" is the 2nd tab, and 3.
"Generate" button is clearly visible on the left wherever you are.

- xdg-open is used on Unix now to open a browser (instead of that old
$BROWSER trick).

- And various other small fixes and improvements, see SVN log...

Michalis

[Pasdoc-main] PasDoc2 branch finished

[Michalis K. <mic...@gm...>]

The PasDoc2 branch is "closed" now. This merely means that I consider
that the useful stuff from PasDoc2 branch is applied to trunk, and this
issue is "done" for PasDoc 0.12.0. The dodi/ and PasDoc2/ branches are
moved to branches/closed/ subdirectory in SVN (so be sure to do "svn
switch" if you were testing them and want to keep doing so).

See SVN commit logs for details about why some small changes were
applied / or not.

Some of the larger changes of PasDoc2 branch had to be rejected, and
left inside branches/closed/PasDoc2/ for everyone to eventually retry.
Some reasons:

0. The failures mentiond in previous mail are the number zero reason...
No matter the rest, we can't apply something that breaks existing stuff.
The smaller things that could be applied, easily and without breaking
anything, are applied.

1. Do not make TPasDoc an all-options container, do not make it an
ancestor of generators, do not pass TPasDoc instance to scanner/tokenizer.

Reasoning: this was breaking the fundamental nice separation between
scanning (parsing etc.) code and generating code. All the generators,
and the scanner, and the parsers "knew" about options of everything
else, which doesn't feel clean.

I started to revert this change, but this lead me to reverting
PasDoc_Base.pas, PasDoc_Gen.pas, which eventually means that other
generators must be carefully fixed back or reverted.

2. Do not make TTokenType public. This drags internal stuff, that should
be only for scanners/parsers communication, into public.

3. I wanted to poke around TPasScope changes, I could see some
potentially useful stuff there, but it's too mixed with the other
changes above. Not really possible to just extract it and apply in
separation, as far as I can see.

Michalis

[Pasdoc-main] [ pasdoc-Patches-3091159 ] improved french translation

[SourceForge.net <no...@so...>]

Patches item #3091159, was opened at 2010-10-20 11:07
Message generated for change (Settings changed) made by kambi
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=304213&aid=3091159&group_id=4213

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: None
>Status: Closed
>Resolution: Accepted
Priority: 5
Private: No
Submitted By: Yann Merignac (yann-m1)
Assigned to: Michalis Kamburelis (kambi)
Summary: improved french translation

Initial Comment:
- more strings translated
- added fr.UTF-8 language

----------------------------------------------------------------------

>Comment By: Michalis Kamburelis (kambi)
Date: 2010-10-26 09:32

Message:
Thank you very much, applied! Just in time for pasdoc 0.12.0 release :)

I also added you to @authors as the beginning of PasDoc_Languages.pas and
to ChangeLog
(http://pasdoc.svn.sourceforge.net/viewvc/pasdoc/trunk/ChangeLog).

New fr.utf8 documented on http://pasdoc.sipsolutions.net/OutputLanguage .

----------------------------------------------------------------------

Comment By: Yann Merignac (yann-m1)
Date: 2010-10-25 19:39

Message:
New version of my patch is ready. See pasdoc_french.tar.gz.

I hope it's more useable this time.



----------------------------------------------------------------------

Comment By: Michalis Kamburelis (kambi)
Date: 2010-10-22 14:50

Message:
A small problem: You based your translation on the "stable" PasDoc 0.11.0
sources. The problem is, a lot of code changed since that time. In
particular, the way translations are defined changed (to using
RTransTable), and a lot of other translations were updated.

So applying your changes is a little difficult.

Could you prepare your changes differently: 

1. Get the PasDoc source code from SVN, see
https://sourceforge.net/scm/?type=svn&group_id=4213 . Or just use "Browse
Subversion Repository" link on that page to download the current
trunk/source/component/PasDoc_Languages.pas file.

2. And apply your changes to this code version.

3. Then attach here your modified files.

Thank you in advance -- this will allow me to apply your changes much
easier. Otherwise, it will be some work, and (since I don't know French) I
could break some strings when moving code around.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=304213&aid=3091159&group_id=4213

[Pasdoc-main] [ pasdoc-Patches-3091159 ] improved french translation

[SourceForge.net <no...@so...>]

Patches item #3091159, was opened at 2010-10-20 11:07
Message generated for change (Settings changed) made by yann-m1
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=304213&aid=3091159&group_id=4213

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: None
>Status: Open
Resolution: None
Priority: 5
Private: No
Submitted By: Yann Merignac (yann-m1)
Assigned to: Michalis Kamburelis (kambi)
Summary: improved french translation

Initial Comment:
- more strings translated
- added fr.UTF-8 language

----------------------------------------------------------------------

>Comment By: Yann Merignac (yann-m1)
Date: 2010-10-25 19:39

Message:
New version of my patch is ready. See pasdoc_french.tar.gz.

I hope it's more useable this time.



----------------------------------------------------------------------

Comment By: Michalis Kamburelis (kambi)
Date: 2010-10-22 14:50

Message:
A small problem: You based your translation on the "stable" PasDoc 0.11.0
sources. The problem is, a lot of code changed since that time. In
particular, the way translations are defined changed (to using
RTransTable), and a lot of other translations were updated.

So applying your changes is a little difficult.

Could you prepare your changes differently: 

1. Get the PasDoc source code from SVN, see
https://sourceforge.net/scm/?type=svn&group_id=4213 . Or just use "Browse
Subversion Repository" link on that page to download the current
trunk/source/component/PasDoc_Languages.pas file.

2. And apply your changes to this code version.

3. Then attach here your modified files.

Thank you in advance -- this will allow me to apply your changes much
easier. Otherwise, it will be some work, and (since I don't know French) I
could break some strings when moving code around.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=304213&aid=3091159&group_id=4213