docview building fails

[xhajt03]

Hi,
There are multiple issues related to docview sources as provided in fpGUI release 2.1.0:

1. The overall project compilation using pasbuild doesn't include docview compilation.
2. README.adoc suggests that "applications" should include the extrafpc.cfg file and should be compiled from within the respective src subdirectory. Docview is explicitly mentioned as an example with the following instructions:

cd docview/src
fpc @extrafpc.cfg docview.lpr

...except that docview/src contains neither extrafpc.cfg (that is one level higher) nor docview.lpr (that is in the subdirectory main/pascal, but the provided extrafpc.cfg doesn't provide the path to this file nor to any other)...

3. One might expect that it should be possible to compile docview using pasbuild.

D:\...\fpGUI-2.1.0>pasbuild compile -m docview -p windows
[INFO] PasBuild 1.9.0 — Born ${build.date}. Raised by Graeme Geldenhuys.
[INFO] Compiler: FPC (fpc)
[INFO] Executing goal: reactor-compile
[ERROR] Module not found: docview
[ERROR] Selected module not found or has no dependencies: docview
[ERROR] Goal failed: reactor-compile

As you can see, although project.xml in the main directory of fpGUI specifies docview as one of modules (there's <module>docview</module>), pasbuild cannot find the module.

OK, docview directory contains project.xml as well - maybe one should try building docview in that directory?

D:\...\fpGUI-2.1.0\docview>pasbuild compile -m docview -p windows
[INFO] PasBuild 1.9.0 — Born ${build.date}. Raised by Graeme Geldenhuys.
[INFO] Compiler: FPC (fpc)
[ERROR] Missing required field: <version>

Well, apparently not. :-( Maybe the version attribute should be added to the project information in docview/project.xml? Let's try again:

D:\...\fpGUI-2.1.0\docview>pasbuild compile -m docview -p windows
[INFO] PasBuild 1.9.0 — Born ${build.date}. Raised by Graeme Geldenhuys.
[INFO] Compiler: FPC (fpc)
[INFO] Executing goal: process-resources
[INFO] Processing resources from src/main/resources...
[INFO] Resources processed successfully
[INFO] Executing goal: compile
[INFO] Compiling project...
[INFO] Found 32 source file(s)
[WARNING] Profile not found: windows
[ERROR] docview.lpr(10,12) Fatal: Can't find unit fpg_main used by docview
[ERROR] Fatal: Compilation aborted
[ERROR] Error: D:\FPC\VerInUse\BIN\i386-win32\ppc386.exe returned an error exitcode
[ERROR] Build failed with exit code: 1 (see target\pasbuild-status\compile\compiler.log for details)
[ERROR] Goal failed: compile

Well, clearly not... :/

After iteratively testing command line compilation and adding needed -Fu and -Fi parameters, I noticed that the line "-Fu../components/richtext/" in current extrafpc.cfg is wrong (there's no such path as "components/richtext/" within the fpGUI project - the real path is "src/main/pascal/richtext/"). In addition, -Fisrc/main/resources needs to be added there as well (currently missing). In addition, subdirectory "units" must be created maually, because extrafpc.cfg specifies that compiled units should go there, but there's no such directory in the tree. After fixing all of that, I was able to compile docview successfully (preferably, the executable should probably end up in a different directory, but that's just a cosmetic thing).

[graemeg]

Thanks for the detailed report! That's really appreciated.

Below I addressed all of the issues you raised:

Build system cleanup

The extrafpc.cfg files were a legacy from before fpGUI adopted PasBuild as its build system. They had
stale paths (the richtext directory reference was wrong, include paths were missing, output
directories didn't exist), which is exactly what tripped you up. I've removed all extrafpc.cfg files
from the project and updated the documentation to reflect PasBuild usage throughout.

I can confirm that DocView is in the module list for the v2.1.0 release and it does build as one of the default enabled modules.

How to build with PasBuild

All commands are run from the project root:

Compile everything (framework, apps, examples, tools)

pasbuild compile -p unix
pasbuild compile -p windows

Compile just the framework

pasbuild compile -m fpgui-framework -p unix

Compile DocView

pasbuild compile -m fpgui-docview -p unix

Compile all examples

pasbuild compile -m fpgui-examples -p unix

Compile a specific example

pasbuild compile -m examples-gui-lmmig -p unix

Missing version field

The "Missing required field: " error occurred because PasBuild was run from inside the
docview/ directory rather than the project root. Sub-modules inherit the version from the root
project.xml, so they don't need their own <version> field — but PasBuild v1.9.0 expects to find one when run
standalone.

Saying that, I've just improved Pasbuild. You can pull the latest pasbuild code, and rebuild the v1.10.0-SNAPSHOT version with your existing PasBuild 1.9.0 binary. New new version will now detect if it was run inside a module directory, and then walk the parent directory tree until it finds the reactor (project.xml that uses pom packaging). So with the new version it will work.

The other subtle thing I noticed. You ran 'pasbuild compile -m docview', because you saw <module>docview</module> in the root project.xml. That <module> tag is actually pointing to the directory where the module is located. It's not the name of the module. the -m argument in v1.9.0 accepts only a module name.

Again, I just updating pasbuild and improved that too. It will now try and find the module by module-name. If that fails, it will fallback and try and determine the module by "find module by directory name". It will also output a HINT that module names should be used, not directories. But it should be a better UX experience.

${build.date} token unresolved

That was my mistake in how I created the pasbuild.exe for the v1.9.0 release. I can confirm that ${build.date} tokens do get expanded correctly, even in the v1.9.0 release. I might have bootstrapped the v1.9.0 binary with a direct fpc command (which obviously doesn't know about resolving tokens in include files), and forgot to rebuild PasBuild again using the pasbuild binary. I've made a note in my release process to make sure I follow the steps correctly.

I believe I answered everything. Feel free to ask more questions. I'll leave this ticket open for a day or two, and then close it, if there is nothing else. 🙂

[andrewd207]

Saying that, I've just improved Pasbuild. You can pull the latest pasbuild code, and rebuild the v1.10.0-SNAPSHOT version with your existing PasBuild 1.9.0 binary. New new version will now detect if it was run inside a module directory, and then walk the parent directory tree until it finds the reactor (project.xml that uses pom packaging). So with the new version it will work.

Thank you for this!!!

[xhajt03]

Thanks, the updated readme file addresses my issues. I'll report the discovered limitations in docview in another report.