pasdoc-main

Re: [Pasdoc-main] Nested types

[Arno G. <arn...@gm...>]

Hans-Peter Diettrich wrote:
> Arno Garrels schrieb:
> 
>> I worked a bit on support for nested types and uploaded
>> a HTML output of a test case here:
>> http://www.duodata.de/misc/delphi/PasDoc/
>> 
>> Currently unit relative qualified names are used for the
>> nested types in overviews. IMO the class hierarchy of all
>> classes should show full qualified names (including unit
>> names) but that looks a bit strange with external,
>> unknown base classes :-( Anyway, what do you think?
> 
> That's okay for the internal representation, but I'd prefer some other
> visual representation (hint?). Fully qualified names can become very
> long... 

If you mean a graphical representation, I haven't seen a good one
yet, at least not with common bigger projects. The current textual
representation is not that bad IMO. 

-- 
Arno Garrels  

Re: [Pasdoc-main] Nested types

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

Arno Garrels schrieb:

> I worked a bit on support for nested types and uploaded
> a HTML output of a test case here:
> http://www.duodata.de/misc/delphi/PasDoc/
> 
> Currently unit relative qualified names are used for the 
> nested types in overviews. IMO the class hierarchy of all
> classes should show full qualified names (including unit
> names) but that looks a bit strange with external,
> unknown base classes :-( Anyway, what do you think?

That's okay for the internal representation, but I'd prefer some other
visual representation (hint?). Fully qualified names can become very long...

DoDi

Re: [Pasdoc-main] Nested types

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

Arno Garrels wrote:
> Hi,
> 
> I worked a bit on support for nested types and uploaded
> a HTML output of a test case here:
> http://www.duodata.de/misc/delphi/PasDoc/

That's cool. It's not committed yet as far as I see?

> 
> Currently unit relative qualified names are used for the 
> nested types in overviews. IMO the class hierarchy of all
> classes should show full qualified names (including unit
> names) but that looks a bit strange with external,
> unknown base classes :-( Anyway, what do you think?
> 

The "external classes" feature can be improved to contain unit names,
that's not a big problem. But I don't know if I like this --- class
hierarchy page would become full of text, and be very difficult to read,
if you add there unit names. That's IMHO of course, others input is welcome.

I would prefer to add unit name (or fully qualified name) as a title in
html output, like <a href="..." title="MyUnit.MyClass">MyClass</a>. In
the future this "title" could also be extended by e.g. position and
filename in the source code, unrelated feature that I would like to add
some day :)

Michalis

[Pasdoc-main] Nested types

[Arno G. <arn...@gm...>]

Hi,

I worked a bit on support for nested types and uploaded
a HTML output of a test case here:
http://www.duodata.de/misc/delphi/PasDoc/

Currently unit relative qualified names are used for the 
nested types in overviews. IMO the class hierarchy of all
classes should show full qualified names (including unit
names) but that looks a bit strange with external,
unknown base classes :-( Anyway, what do you think?

-- 
Arno Garrels

Re: [Pasdoc-main] Adding new tags

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

Flavio Campana wrote:
>   I need to add some tag to PasDoc (especially @version and @since), 
> nad, if i understood it correctly, i must afdd writing methods in 
> pasdoc_gen.pas (and derived), and reading methods in pasdoc_items. Is 
> that right?
> 

It depends on what @tag you make. Typical formatting tags are registered
in PasDoc_Gen and formatted in derived classes. Tags that need a special
TBaseItem/TPasItem property are registered in PasDoc_Items and formatted
in particular generators (PasDoc_GenHtml, PasDoc_GenLatex).

@version an @since tag seem like the 2nd case, so yes. Grep for e.g.
"lastmod" to see how it's handled.

Michalis

[Pasdoc-main] Adding new tags

[Flavio C. <sil...@gm...>]

  I need to add some tag to PasDoc (especially @version and @since), 
nad, if i understood it correctly, i must afdd writing methods in 
pasdoc_gen.pas (and derived), and reading methods in pasdoc_items. Is 
that right?

[Pasdoc-main] [ pasdoc-Bugs-3104547 ] Don't parse 'cvar' keyword

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

Bugs item #3104547, was opened at 2010-11-07 15:50
Message generated for change (Comment added) made by 
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3104547&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.1
Status: Closed
Resolution: Fixed
Priority: 5
Private: No
Submitted By: http://shikhalev.blogspot.com/ ()
Assigned to: Michalis Kamburelis (kambi)
Summary: Don't parse 'cvar' keyword

Initial Comment:
In FPC sources pasdoc make an error when parse 'cvar' keyword (for external variables). Sample minimal unit is attached.

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

Comment By: http://shikhalev.blogspot.com/ ()
Date: 2010-11-07 17:31

Message:
Thank you!

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-07 16:48

Message:
Fixed, thanks for reporting!

Testcase tests/ok_cvar.pas added.

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

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

[Pasdoc-main] [ pasdoc-Bugs-3104547 ] Don't parse 'cvar' keyword

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

Bugs item #3104547, was opened at 2010-11-07 11:50
Message generated for change (Comment added) made by kambi
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3104547&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.1
>Status: Closed
>Resolution: Fixed
Priority: 5
Private: No
Submitted By: http://shikhalev.blogspot.com/ ()
Assigned to: Michalis Kamburelis (kambi)
Summary: Don't parse 'cvar' keyword

Initial Comment:
In FPC sources pasdoc make an error when parse 'cvar' keyword (for external variables). Sample minimal unit is attached.

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

>Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-07 12:48

Message:
Fixed, thanks for reporting!

Testcase tests/ok_cvar.pas added.

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

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

[Pasdoc-main] [ pasdoc-Bugs-3104547 ] Don't parse 'cvar' keyword

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

Bugs item #3104547, was opened at 2010-11-07 11:50
Message generated for change (Settings changed) made by kambi
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3104547&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.1
Status: Open
Resolution: None
Priority: 5
Private: No
Submitted By: http://shikhalev.blogspot.com/ ()
>Assigned to: Michalis Kamburelis (kambi)
Summary: Don't parse 'cvar' keyword

Initial Comment:
In FPC sources pasdoc make an error when parse 'cvar' keyword (for external variables). Sample minimal unit is attached.

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

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

[Pasdoc-main] [ pasdoc-Bugs-3104547 ] Don't parse 'cvar' keyword

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

Bugs item #3104547, was opened at 2010-11-07 15:50
Message generated for change (Tracker Item Submitted) made by 
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3104547&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.1
Status: Open
Resolution: None
Priority: 5
Private: No
Submitted By: http://shikhalev.blogspot.com/ ()
Assigned to: Nobody/Anonymous (nobody)
Summary: Don't parse 'cvar' keyword

Initial Comment:
In FPC sources pasdoc make an error when parse 'cvar' keyword (for external variables). Sample minimal unit is attached.

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

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=104213&aid=3104547&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 gskoczylas
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: 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: Grzegorz Skoczylas (gskoczylas)
Date: 2010-11-03 23:55

Message:
Please ignore my previous comment. I did not notice that it is already
implemented in PasDoc 0.12.1.

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

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

Message:
Maybe a good solution would be to add a version identifier to the cache
file. If the version identifier read from the cache file would be different
from the version of the PasDoc, such a cache file would automatically be
regarded as outdated.

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-03 16:48

Message:
With new PasDoc 0.12.1, the cache files from the old PasDoc version will be
automatically detected and overridden.

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

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 gskoczylas
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: Grzegorz Skoczylas (gskoczylas)
Date: 2010-11-03 23:50

Message:
Maybe a good solution would be to add a version identifier to the cache
file. If the version identifier read from the cache file would be different
from the version of the PasDoc, such a cache file would automatically be
regarded as outdated.

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-03 16:48

Message:
With new PasDoc 0.12.1, the cache files from the old PasDoc version will be
automatically detected and overridden.

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

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-03 16:48

Message:
With new PasDoc 0.12.1, the cache files from the old PasDoc version will be
automatically detected and overridden.

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

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 0.12.1 release!

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

Hi everyone,

PasDoc 0.12.1 was just released. The main reason for the release is the
bug when handling files with UTF-8 BOM that slipped into 0.12.0 release.
We also handle new Delphi features (Delphi operator overloads, anonymous
methods, class and record helpers), for which credits go to Arno
Garrels. See our ChangeLog file.

The release is done for the same 4 platforms that 0.12.0 (Linux/i386,
Linux/x86_64, Windows/i386, MacOSX/i386). Packages may be downloaded
from the usual place:
  https://sourceforge.net/projects/pasdoc/files/

Well, that was fun :) I dare you all to implement enough features to
make another PasDoc release in 3 days from now :)

Michalis

[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 kambi
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: Closed
Resolution: Fixed
Priority: 4
Private: No
Submitted By: Grzegorz Skoczylas (gskoczylas)
Assigned to: Michalis Kamburelis (kambi)
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: Michalis Kamburelis (kambi)
Date: 2010-11-03 14:31

Message:
>Just a note on the FPC scanner: when the scanner skips the BOM, it
erroneously returns the first char of the BOM, instead of the next char.

Our scanner is not based on the FPC scanner. The bug was our own :)

In other news: 0.12.1 will be released later today to make this fixed also
in released versions.

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

Comment By: Dr. Diettrich (drdiettrich)
Date: 2010-11-03 14:02

Message:
Just a note on the FPC scanner: when the scanner skips the BOM, it
erroneously returns the first char of the BOM, instead of the next char.
Dunno whether the same bug was copied into the PasDoc code.

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-03 10:30

Message:
> only I wonder why you did not just made the stack array 1-base?

That's because I planned to cleanup the SkipBOM code anyway, to avoid the
loop at all, just like your TStreamReader.GetCodePageFromBOM. It is done
now :)

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

Comment By: aguser (garrels)
Date: 2010-11-03 09:56

Message:
> Ok, my fix was actually complete :) Closing.

Mea culpa, sorry, only I wonder why you did not just made the stack array
1-base?
We are dealing with bytes there not with chars, anyway thanks for the fix.

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

Comment By: Grzegorz Skoczylas (gskoczylas)
Date: 2010-11-03 09:53

Message:
So far I used the PasDoc.exe downloaded from SourceForge.net. Today I
updated the PasDoc's source code and compiled (with Delphi2007). From now
on, the PasDoc does not have any problem with BOM.

Thanks!

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-03 06:58

Message:
Ok, my fix was actually complete :) Closing.

Testcase in tests/ok_bom.pas, so we will not break it again :)

Tested with FPC, and should work equally good with non-Unicode Delphi (for
Unicode Delphi, BOM is detected in other place, I assume that's working
Ok). Please reopen if you still see the problem with Delphi.

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-03 06:38

Message:
I can reproduce with FPC.

Our TPasDoc.SkipBOM method stopped working correctly after changes in rev
1221 (BOM array was assumed to be 1-based by the following code). Also
something else is broken, not sure yet what (even when TPasDoc.SkipBOM
skips correctly, something else still sees the bom character in the
stream).

I have committed a partial fix, and will look into it more now :)

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

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

Re: [Pasdoc-main] Should we make 0.12.1 bugfix release? Does Delphi add (by default) UTF-8 BOM?

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

Arno Garrels wrote:
> IMO PasDoc should detect all BOMs used by Delphi and raise an exception
> if a charset is not supported.

The SVN already detected UTF-8 and both UTF-16 BOMs. (In case of UTF-16,
this merely causes clear error messages when compiled without
STRING_UNICODE.)

And, I just committed a code to detect UTF-32 BOMs. So this is complete.
(You may want to make similar changes as I did in rev 1265 to the
TStreamReader.GetCodePageFromBOM).

> That would be nice for the non-svn users.

Ok, so let's release PasDoc 0.12.1. I'll do it... well, right now :)

(Only, first I'll make a promised "version marker" for cache files, to
improve serialization troubles mentioned in #3101524).

Michalis

Re: [Pasdoc-main] Should we make 0.12.1 bugfix release? Does Delphi add (by default) UTF-8 BOM?

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

Michalis Kamburelis schrieb:
> Looks like a bug slipped into 0.12.0 release that prevents reading files
> starting with UTF-8 BOM. It's fixed now of course in SVN.

I came across the same problem in the FPC scanner. The scanner skips the 
BOM, but then erroneously returns the first char of the BOM instead of 
the next char. Dunno what's the problem with PasDoc, but it seems to be 
resolved.

DoDi

[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 drdiettrich
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: Closed
Resolution: Fixed
Priority: 4
Private: No
Submitted By: Grzegorz Skoczylas (gskoczylas)
Assigned to: Michalis Kamburelis (kambi)
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: Dr. Diettrich (drdiettrich)
Date: 2010-11-03 14:02

Message:
Just a note on the FPC scanner: when the scanner skips the BOM, it
erroneously returns the first char of the BOM, instead of the next char.
Dunno whether the same bug was copied into the PasDoc code.

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-03 10:30

Message:
> only I wonder why you did not just made the stack array 1-base?

That's because I planned to cleanup the SkipBOM code anyway, to avoid the
loop at all, just like your TStreamReader.GetCodePageFromBOM. It is done
now :)

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

Comment By: aguser (garrels)
Date: 2010-11-03 09:56

Message:
> Ok, my fix was actually complete :) Closing.

Mea culpa, sorry, only I wonder why you did not just made the stack array
1-base?
We are dealing with bytes there not with chars, anyway thanks for the fix.

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

Comment By: Grzegorz Skoczylas (gskoczylas)
Date: 2010-11-03 09:53

Message:
So far I used the PasDoc.exe downloaded from SourceForge.net. Today I
updated the PasDoc's source code and compiled (with Delphi2007). From now
on, the PasDoc does not have any problem with BOM.

Thanks!

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-03 06:58

Message:
Ok, my fix was actually complete :) Closing.

Testcase in tests/ok_bom.pas, so we will not break it again :)

Tested with FPC, and should work equally good with non-Unicode Delphi (for
Unicode Delphi, BOM is detected in other place, I assume that's working
Ok). Please reopen if you still see the problem with Delphi.

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-03 06:38

Message:
I can reproduce with FPC.

Our TPasDoc.SkipBOM method stopped working correctly after changes in rev
1221 (BOM array was assumed to be 1-based by the following code). Also
something else is broken, not sure yet what (even when TPasDoc.SkipBOM
skips correctly, something else still sees the bom character in the
stream).

I have committed a partial fix, and will look into it more now :)

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

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

Re: [Pasdoc-main] Should we make 0.12.1 bugfix release? Does Delphi add (by default) UTF-8 BOM?

[Arno G. <arn...@gm...>]

Michalis Kamburelis wrote:
> Looks like a bug slipped into 0.12.0 release that prevents reading
> files starting with UTF-8 BOM. It's fixed now of course in SVN.
> 
> I know that Lazarus and most text editors in general do not add UTF-8
> BOM, so I think this isn't a problem for FPC/Lazarus users. 

Using UTF-8 without BOM is eval IMO, since there is no way to detect 
a charset reliable. Any test can only verify that it is correctly 
encoded UTF-8, it might be a different charset nevertheless, and 
testing is expensive.

> large problem for Delphi users? 

I do not know how many users actually use UTF-8 source files? 

> Does some new Delphi version automatically add UTF-8 BOM? 

Yes, when it opened a UTF-8 source file without BOM (detected), it's
saved with a BOM silently (just tested in XE). In all other cases you 
have to convert a unit to UTF-8, UCS-2, UCS-2Be or UCS-4 and UCS-4Be 
explicitly in editor's context menu before Delphi saved it with a BOM,
the default is still ANSI. 

IMO PasDoc should detect all BOMs used by Delphi and raise an exception
if a charset is not supported.
  
> Bear in mind that I do not use/own Delphi
> since a long time, so I'm asking you.
> 
> If you guys think so, we can make a 0.12.1 bugfix release, even today.

That would be nice for the non-svn users.

-- 
Arno Garrels

[Pasdoc-main] Should we make 0.12.1 bugfix release? Does Delphi add (by default) UTF-8 BOM?

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

Looks like a bug slipped into 0.12.0 release that prevents reading files
starting with UTF-8 BOM. It's fixed now of course in SVN.

I know that Lazarus and most text editors in general do not add UTF-8
BOM, so I think this isn't a problem for FPC/Lazarus users. Is it a
large problem for Delphi users? Does some new Delphi version
automatically add UTF-8 BOM? Bear in mind that I do not use/own Delphi
since a long time, so I'm asking you.

If you guys think so, we can make a 0.12.1 bugfix release, even today.

Arno implemented handling of some new Delphi features in the last days
(look at ChangeLog file), so we even have something new already :)

Michalis

[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 kambi
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: Closed
Resolution: Fixed
Priority: 4
Private: No
Submitted By: Grzegorz Skoczylas (gskoczylas)
Assigned to: Michalis Kamburelis (kambi)
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: Michalis Kamburelis (kambi)
Date: 2010-11-03 10:30

Message:
> only I wonder why you did not just made the stack array 1-base?

That's because I planned to cleanup the SkipBOM code anyway, to avoid the
loop at all, just like your TStreamReader.GetCodePageFromBOM. It is done
now :)

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

Comment By: aguser (garrels)
Date: 2010-11-03 09:56

Message:
> Ok, my fix was actually complete :) Closing.

Mea culpa, sorry, only I wonder why you did not just made the stack array
1-base?
We are dealing with bytes there not with chars, anyway thanks for the fix.

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

Comment By: Grzegorz Skoczylas (gskoczylas)
Date: 2010-11-03 09:53

Message:
So far I used the PasDoc.exe downloaded from SourceForge.net. Today I
updated the PasDoc's source code and compiled (with Delphi2007). From now
on, the PasDoc does not have any problem with BOM.

Thanks!

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-03 06:58

Message:
Ok, my fix was actually complete :) Closing.

Testcase in tests/ok_bom.pas, so we will not break it again :)

Tested with FPC, and should work equally good with non-Unicode Delphi (for
Unicode Delphi, BOM is detected in other place, I assume that's working
Ok). Please reopen if you still see the problem with Delphi.

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-03 06:38

Message:
I can reproduce with FPC.

Our TPasDoc.SkipBOM method stopped working correctly after changes in rev
1221 (BOM array was assumed to be 1-based by the following code). Also
something else is broken, not sure yet what (even when TPasDoc.SkipBOM
skips correctly, something else still sees the bom character in the
stream).

I have committed a partial fix, and will look into it more now :)

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

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: Closed
Resolution: Fixed
Priority: 4
Private: No
Submitted By: Grzegorz Skoczylas (gskoczylas)
Assigned to: Michalis Kamburelis (kambi)
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-03 09:56

Message:
> Ok, my fix was actually complete :) Closing.

Mea culpa, sorry, only I wonder why you did not just made the stack array
1-base?
We are dealing with bytes there not with chars, anyway thanks for the fix.

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

Comment By: Grzegorz Skoczylas (gskoczylas)
Date: 2010-11-03 09:53

Message:
So far I used the PasDoc.exe downloaded from SourceForge.net. Today I
updated the PasDoc's source code and compiled (with Delphi2007). From now
on, the PasDoc does not have any problem with BOM.

Thanks!

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-03 06:58

Message:
Ok, my fix was actually complete :) Closing.

Testcase in tests/ok_bom.pas, so we will not break it again :)

Tested with FPC, and should work equally good with non-Unicode Delphi (for
Unicode Delphi, BOM is detected in other place, I assume that's working
Ok). Please reopen if you still see the problem with Delphi.

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-03 06:38

Message:
I can reproduce with FPC.

Our TPasDoc.SkipBOM method stopped working correctly after changes in rev
1221 (BOM array was assumed to be 1-based by the following code). Also
something else is broken, not sure yet what (even when TPasDoc.SkipBOM
skips correctly, something else still sees the bom character in the
stream).

I have committed a partial fix, and will look into it more now :)

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

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 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: Closed
Resolution: Fixed
Priority: 4
Private: No
Submitted By: Grzegorz Skoczylas (gskoczylas)
Assigned to: Michalis Kamburelis (kambi)
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 09:53

Message:
So far I used the PasDoc.exe downloaded from SourceForge.net. Today I
updated the PasDoc's source code and compiled (with Delphi2007). From now
on, the PasDoc does not have any problem with BOM.

Thanks!

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-03 06:58

Message:
Ok, my fix was actually complete :) Closing.

Testcase in tests/ok_bom.pas, so we will not break it again :)

Tested with FPC, and should work equally good with non-Unicode Delphi (for
Unicode Delphi, BOM is detected in other place, I assume that's working
Ok). Please reopen if you still see the problem with Delphi.

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-03 06:38

Message:
I can reproduce with FPC.

Our TPasDoc.SkipBOM method stopped working correctly after changes in rev
1221 (BOM array was assumed to be 1-based by the following code). Also
something else is broken, not sure yet what (even when TPasDoc.SkipBOM
skips correctly, something else still sees the bom character in the
stream).

I have committed a partial fix, and will look into it more now :)

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

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 kambi
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: Closed
>Resolution: Fixed
Priority: 4
Private: No
Submitted By: Grzegorz Skoczylas (gskoczylas)
Assigned to: Michalis Kamburelis (kambi)
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: Michalis Kamburelis (kambi)
Date: 2010-11-03 06:58

Message:
Ok, my fix was actually complete :) Closing.

Testcase in tests/ok_bom.pas, so we will not break it again :)

Tested with FPC, and should work equally good with non-Unicode Delphi (for
Unicode Delphi, BOM is detected in other place, I assume that's working
Ok). Please reopen if you still see the problem with Delphi.

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

Comment By: Michalis Kamburelis (kambi)
Date: 2010-11-03 06:38

Message:
I can reproduce with FPC.

Our TPasDoc.SkipBOM method stopped working correctly after changes in rev
1221 (BOM array was assumed to be 1-based by the following code). Also
something else is broken, not sure yet what (even when TPasDoc.SkipBOM
skips correctly, something else still sees the bom character in the
stream).

I have committed a partial fix, and will look into it more now :)

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

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 kambi
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: Michalis Kamburelis (kambi)
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: Michalis Kamburelis (kambi)
Date: 2010-11-03 06:38

Message:
I can reproduce with FPC.

Our TPasDoc.SkipBOM method stopped working correctly after changes in rev
1221 (BOM array was assumed to be 1-based by the following code). Also
something else is broken, not sure yet what (even when TPasDoc.SkipBOM
skips correctly, something else still sees the bom character in the
stream).

I have committed a partial fix, and will look into it more now :)

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

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