Skip to content

Commit

Permalink
This patch contains changes regarding the build system so that the *n…
Browse files Browse the repository at this point in the history
…ix and Windows systems use the same information (consistency). Some use names routine names have been changed (from .l files with -P option) to reflect the file name that generated the routines, this makes it easier to create a general procedure.

A number of include / header files are files are generated from different file types (html, xml, js), due some limitations of the windows build system the generated file names had to be changed (the extension in the windows build system is only available including the '.' so e.g. the file jquery_fx.js generates now jquery_fx.js.h instead of jquery_fx_js.h)
In the windows version the creation of .cpp files from .l files has been adjusted to correct for the YY_BUF_SIZE problems.
Furthermore on windows (and also used on *nix) some commends have been replaced with python scripts so that on windows only python is need (besides flex and and bison). On *nix also perl is required for the generation using tmake.

Below a short description of the changes will be given and grouped.

Changed files
=============
- .gitignore
added some directories and file

- Doxyfile
corrected for changed file names

- Makefile.in
added realclean and some other changes (ignore error) and the moment when the Makefile is deleted (as last file).
Added entries for doxyapp and doxmlparser

Added realclean for the following files (consistency):
======================================================
- Makefile.win_make.in
- Makefile.win_nmake.in
- addon/doxmlparser/examples/metrics/Makefile.in
- addon/doxmlparser/src/Makefile.in
- addon/doxmlparser/test/Makefile.in
- addon/doxyapp/Makefile.in
- addon/doxysearch/Makefile.in
- libmd5/Makefile.in
- qtools/Makefile.in

- addon/doxyapp/doxyapp.pro.in
removed double occurence of -L../../lib

- addon/doxysearch/doxysearch.pro.in
no visible change just spacing?

- addon/doxywizard/Makefile.in
added realclean
corrected call to qmake (to get it from the right place, it is not necessarily in the path)
made some macros known in the called process

- addon/doxywizard/configdoc.cpp
automatically generated, can be removed

- addon/doxywizard/doxywizard.pro.in
corrected dependencies
corrected call to python (to get it from the right place, it is not necessarily in the path)
new items to generate version.cpp and config_doxyw.cpp

- configure
added configuration definition possibility for python
added possibility to build doxmlparser
automatically generate the lang_cfg.h file based on the available languages (translator_??.h) and not on a fixed list. This step still has to be added to the windows build process.

- doc/Makefile.in
corrected call to python (to get it from the right place, it is not necessarily in the path)

- doc/config.doc
small correction

- doc/install.doc
added python as a requirement
changed CVS to GitHub

- doc/language.doc
automatically generated file, based on other changes.

- doc/language.tpl
made XX and xx more consistent
changed description of the procedure based on changes already made configure.

- src/Makefile.in
adjusted used file names in distclean
Solved PERL usage consistent with LEX / YACC (with %%PERL%%)
automatically add translator_??>h to HEADERS
same spacing

Adjusted in the following file the names of some include files:
===============================================================
- src/cite.cpp
- src/docbookgen.cpp
- src/ftvhelp.cpp
- src/htmlgen.cpp
- src/layout.cpp
- src/searchindex.cpp
- src/xmlgen.cpp

Adjusted in the following files some routine names (..YY..) to be consistent with the file names:
=================================================================================================
- src/commentscan.l
- src/constexp.h
- src/constexp.l
- src/constexp.y
- src/fortrancode.l
- src/fortranscanner.l
- src/pyscanner.l
- src/pre.l
- src/scanner.l
- src/tclscanner.l
- src/vhdlparser.y
- src/vhdlscanner.l

- src/config.xml
small textual correction

- src/configoptions.cpp
generated output file, can be removed

- src/lang_cfg.h
Automatically generated file with selected languages (*nix). On windows a procedure has to be defined.

- src/libdoxycfg.t.in
corrected call to python (to get it from the right place, it is not necessarily in the path)

- src/libdoxygen.pro.in
adjusted include file names
removed translator_??.h files, they are added automatically
changed file name ce_lex.cpp -> constexp.cpp (generated file)

- src/libdoxygen.t.in
made LEX calls used the file name for the -P option
changed INCREASEBUF script to a python script
changed teh geneartion of some include file, now by means of a pythons script. Names of the generated include file had to be changed as well.
added possibility to generate version.cpp here as well.

Added HEADERS to dependency so non existing but later generated include files are recognized as well:
=====================================================================================================
- tmake/lib/unix/generic.t
- tmake/lib/win32-borland/generic.t
- tmake/lib/win32-g++/generic.t
- tmake/lib/win32-mingw/generic.t
- tmake/lib/win32-msvc/generic.t
- tmake/lib/win32-symantec/generic.t
- tmake/lib/win32-visage/generic.t
- tmake/lib/win32-watcom/generic.t

- winbuild/Doxygen.vcproj
made consistent wit *nix version.
Generating all possible files
removed unused /empty parts
setting for the Lex.rules and other rules files some default values

- winbuild/Doxywizard.vcproj
made consistent wit *nix version.
Generating all possible files
removed unused /empty parts
removed system dependent paths (C:\... etc) replaced then with external environment variables

- winbuild/Lex.rules
adjusted file to comply with new requirements, only user variable is -d. -i is set to read only (value can be changed  in doxygen.vcproj). Handling of other arguments is all default.
generation including increasebuffer possibility

- winbuild/doxyindexer.vcproj
corrected path

- winbuild/doxysearch.vcproj
removed system dependent paths (C:\... etc) replaced then with external environment variables

- winbuild/qtools.vcproj
corrected type, wrong used directory

The following files are automatically generated (with slightly other names like index.xsd.h etc.):
==================================================================================================
- src/index_xsd.h
- src/doxygen_bst.h
- src/dynsections_js.h
- src/extsearch_js.h
- src/footer_html.h
- src/header_html.h
- src/jquery_fx_js.h
- src/jquery_p1_js.h
- src/jquery_p2_js.h
- src/jquery_p3_js.h
- src/jquery_pt_js.h
- src/jquery_ui_js.h
- src/navtree_css.h
- src/navtree_js.h
- src/resize_js.h
- src/search_css.h
- src/search_functions_php.h
- src/search_js.h
- src/search_opensearch_php.h
- src/svgpan_js.h
the following files are generated with different names:
- src/bib2xhtml.h
becomes
- src/bib2xhtml.pl/h

- src/layout_default.h
becomes
- src/layout_default.xml.h

The file:
=========
- addon/doxywizard/config.l
is replaced by:
- addon/doxywizard/config_doxyw.l
so there are in the system not 2 different config.l files. Renamed some routines from configYY -> config_doxywYY...

New files:
==========
- src/increasebuffer.py
increase YY_BUF_SIZE and YY_READ_BUF_SIZE from 16k / 8k to 256k.

- src/settings.py
create settings.h file

- src/to_c_cmd.py
create include files from different files (html, xml, js) so they can be included in the code as defaults

- src/version.py
create version.cpp file based on the configure file

- winbuild/Config.rules
rules file to convert the config.xml file into configoptions.cpp (doxygen) or configdoc.cpp (doxywizard). Seen the differences 2 rules are created within this file.

- winbuild/Gen_head.rules
rules files to generate include files from different files using to_c_cmd.py

- winbuild/Settings.rules
rules file for generating the settings.h file. It is possible to select to use CLANG and SqlLite3

- winbuild/Version.rules
rules file to be able to start version.py

The files:
==========
- version.bat
- runbison.bat
- increasebuffer.pl
are not used anymore.

I've only added the files as indicated, I didn't remove the files from the repository.
  • Loading branch information
albert-github authored and Dimitri van Heesch committed Oct 6, 2013
1 parent e835d4b commit ac2cd57
Show file tree
Hide file tree
Showing 75 changed files with 2,063 additions and 2,802 deletions.
32 changes: 32 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@
/addon/doxywizard/moc
/addon/doxywizard/obj
/addon/doxywizard/rcc
/addon/doxmlparser/objects
/addon/doxmlparser/lib
/addon/doxmlparser/test/Makefile.xmlparse
/addon/doxmlparser/test/xmlparse.exe
/addon/doxmlparser/examples/metrics/obj
/addon/doxmlparser/examples/metrics/metrics.exe
/winbuild/config_lex.cpp
/winbuild/moc
/winbuild/obj
Expand Down Expand Up @@ -72,6 +78,32 @@
/src/vhdlparser.h
/src/vhdlscanner.cpp
/src/Makefile
/src/bib2xhtml.pl.h
/src/compound.xsd.h
/src/constexp.cpp
/src/doxygen.bst.h
/src/doxygen.css.h
/src/dynsections.js.h
/src/extsearch.js.h
/src/footer.html.h
/src/header.html.h
/src/index.xsd.h
/src/jquery_fx.js.h
/src/jquery_p1.js.h
/src/jquery_p2.js.h
/src/jquery_p3.js.h
/src/jquery_pt.js.h
/src/jquery_ui.js.h
/src/layout_default.xml.h
/src/navtree.css.h
/src/navtree.js.h
/src/resize.js.h
/src/search.css.h
/src/search.js.h
/src/search_functions.php.h
/src/search_opensearch.php.h
/src/svgpan.js.h


/doc/Makefile
/doc/translator_report.txt
Expand Down
49 changes: 24 additions & 25 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -127,31 +127,30 @@ EXCLUDE = src/code.cpp \
src/vhdlcode.cpp \
src/tclscanner.cpp \
src/lodepng.cpp \
src/doxygen_css.h \
src/doxygen_js.h \
src/doxygen_php.h \
src/compound_xsd.h \
src/layout_default.h \
src/bib2xhtml.h \
src/doxygen_bst.h \
src/header_html.h \
src/index_xsd.h \
src/jquery_js.h \
src/jquery_fx_js.h \
src/jquery_ui_js.h \
src/navtree_css.h \
src/navtree_hs.h \
src/search_css.h \
src/search_functions_php.h \
src/search_opensearch_php.h \
src/search_js.h \
src/sizzle_js.h \
src/navtree_js.h \
src/resize_js.h \
src/svgpan_js.h \
src/dynsections_js.h \
src/extsearch_js.h \
src/footer_html.h
src/doxygen.css.h \
src/doxygen.js.h \
src/doxygen.php.h \
src/compound.xsd.h \
src/layout_default.xml.h \
src/bib2xhtml.pl.h \
src/doxygen.bst.h \
src/header.html.h \
src/index.xsd.h \
src/jquery.js.h \
src/jquery_fx.js.h \
src/jquery_ui.js.h \
src/navtree.css.h \
src/navtree.hs.h \
src/search.css.h \
src/search_functions.php.h \
src/search_opensearch.php.h \
src/search.js.h \
src/navtree.js.h \
src/resize.js.h \
src/svgpan.js.h \
src/dynsections.js.h \
src/extsearch.js.h \
src/footer.html.h
EXCLUDE_SYMLINKS = NO
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
Expand Down
43 changes: 34 additions & 9 deletions Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,20 @@ doxywizard:
doxysearch:
cd addon/doxysearch ; $(MAKE)

doxmlparser:
cd addon/doxmlparser/src ; $(MAKE)
cd addon/doxmlparser/test ; $(MAKE)
cd addon/doxmlparser/examples/metrics ; $(MAKE)

doxyapp:
cd addon/doxyapp ; $(MAKE) clean

clean: FORCE
cd examples ; $(MAKE) clean
cd doc ; $(MAKE) clean
cd qtools ; $(MAKE) clean
cd src ; $(MAKE) clean
cd libmd5 ; $(MAKE) clean
- cd examples ; $(MAKE) clean
- cd doc ; $(MAKE) clean
- cd qtools ; $(MAKE) clean
- cd src ; $(MAKE) clean
- cd libmd5 ; $(MAKE) clean
-cd addon/doxywizard ; $(MAKE) clean
-cd addon/doxysearch ; $(MAKE) clean
-cd addon/doxyapp ; $(MAKE) clean
Expand All @@ -26,8 +34,8 @@ clean: FORCE
-rm -f objects/*.o

distclean: clean
cd src ; $(MAKE) distclean
cd libmd5 ; $(MAKE) distclean
-cd src ; $(MAKE) distclean
-cd libmd5 ; $(MAKE) distclean
-cd addon/doxywizard ; $(MAKE) distclean
-cd addon/doxysearch ; $(MAKE) distclean
-cd addon/doxyapp ; $(MAKE) distclean
Expand All @@ -42,14 +50,31 @@ distclean: clean
-rm -f src/Makefile.doxygen src/Makefile.libdoxygen
-rm -f src/Makefile.libdoxycfg src/libdoxycfg.t src/libdoxygen.t
-rm -f libmd5/Makefile.libmd5
-rm -f Makefile qtools/Makefile src/Makefile examples/Makefile doc/Makefile
-rm -f .makeconfig .tmakeconfig
-rm -f src/doxygen.pro src/libdoxygen.pro qtools/qtools.pro src/libdoxycfg.pro libmd5/libmd5.pro
-rm -f src/version.cpp
-rm -r addon/doxywizard/Makefile
-rm -f addon/doxywizard/doxywizard.pro
-rm -f VERSION
-rm -f packages/rpm/doxygen.spec
-rm -r addon/doxywizard/Makefile
-rm -f addon/doxysearch/Makefile
-rm -f addon/doxyapp/Makefile
-rm -f addon/doxmlparser/src/Makefile
-rm -f addon/doxmlparser/test/Makefile
-rm -f addon/doxmlparser/examples/metrics/Makefile
-rm -f qtools/Makefile src/Makefile examples/Makefile doc/Makefile
-rm -f Makefile

realclean: clean
-cd src ; $(MAKE) realclean
-cd libmd5 ; $(MAKE) realclean
-cd addon/doxywizard ; $(MAKE) realclean
-cd addon/doxysearch ; $(MAKE) realclean
-cd addon/doxyapp ; $(MAKE) realclean
-cd addon/doxmlparser/src ; $(MAKE) realclean
-cd addon/doxmlparser/test ; $(MAKE) realclean
-cd addon/doxmlparser/examples/metrics ; $(MAKE) realclean
-$(MAKE) distclean

DATE=$(shell date "+%B %Y")

Expand Down
2 changes: 2 additions & 0 deletions Makefile.win_make.in
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ distclean: clean
-del src\libdoxygen.pro src\doxygen.pro src\libdoxycfg.pro
-del src\version.cpp

realclean: distclean

docs:
set TMAKEPATH=$(TMAKEPATH) & cd examples & $(MAKE)
set TMAKEPATH=$(TMAKEPATH) & cd doc & $(MAKE)
Expand Down
2 changes: 2 additions & 0 deletions Makefile.win_nmake.in
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ distclean: clean
-del src\libdoxygen.pro src\doxygen.pro src\libdoxycfg.pro
-del src\version.cpp

realclean: distclean

docs: FORCE
cd examples
$(MAKE)
Expand Down
2 changes: 2 additions & 0 deletions addon/doxmlparser/examples/metrics/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ all clean depend: Makefile.metrics
distclean: clean
$(RM) -rf Makefile.metrics metrics.pro Makefile obj

realclean: distclean

tmake:
$(ENV) $(PERL) $(TMAKE) metrics.pro >Makefile.metrics

Expand Down
2 changes: 2 additions & 0 deletions addon/doxmlparser/src/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ all clean depend: Makefile.doxmlparser
distclean: clean
$(RM) -rf Makefile.doxmlparser doxmlparser.pro Makefile obj

realclean: distclean

tmake:
$(ENV) $(PERL) $(TMAKE) doxmlparser.pro >Makefile.doxmlparser

Expand Down
2 changes: 2 additions & 0 deletions addon/doxmlparser/test/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ all clean depend: Makefile.xmlparse
distclean: clean
$(RM) -rf Makefile.xmlparse xmlparse.pro Makefile obj

realclean: distclean

tmake:
$(ENV) $(PERL) $(TMAKE) xmlparse.pro >Makefile.xmlparse

Expand Down
2 changes: 2 additions & 0 deletions addon/doxyapp/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ all clean depend distclean: Makefile.doxyapp
distclean: clean
$(RM) -rf Makefile doxyapp.pro Makefile.doxyapp

realclean: distclean

tmake:
$(ENV) $(PERL) "$(TMAKE)" doxyapp.pro >Makefile.doxyapp

Expand Down
2 changes: 1 addition & 1 deletion addon/doxyapp/doxyapp.pro.in
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ TEMPLATE = app.t
CONFIG = console warn_on debug
HEADERS =
SOURCES = doxyapp.cpp
LIBS += -L../../lib -L../../lib -ldoxygen -lqtools -lmd5 -ldoxycfg -lpthread
LIBS += -L../../lib -ldoxygen -lqtools -lmd5 -ldoxycfg -lpthread -liconv
DESTDIR =
OBJECTS_DIR = ../../objects
TARGET = ../../bin/doxyapp
Expand Down
2 changes: 2 additions & 0 deletions addon/doxysearch/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ distclean: clean
$(RM) -rf Makefile doxysearch.pro Makefile.doxysearch
$(RM) -rf Makefile doxyindexer.pro Makefile.doxyindexer

realclean: distclean

tmake:
$(ENV) $(PERL) "$(TMAKE)" doxysearch.pro >Makefile.doxysearch
$(ENV) $(PERL) "$(TMAKE)" doxyindexer.pro >Makefile.doxyindexer
Expand Down
2 changes: 1 addition & 1 deletion addon/doxysearch/doxysearch.pro.in
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ TEMPLATE = app.t
CONFIG = console warn_on debug
HEADERS =
SOURCES = doxysearch.cpp
LIBS += -lxapian
LIBS += -lxapian
DESTDIR =
OBJECTS_DIR = ../../objects
TARGET = ../../bin/doxysearch.cgi
Expand Down
10 changes: 8 additions & 2 deletions addon/doxywizard/Makefile.in
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@
# See the GNU General Public License for more details.
#

QMAKE=qmake $(MKSPECS)
QMAKE=$(QTDIR)/bin/qmake $(MKSPECS)
INCBUFSIZE=$(PYTHON) ../../src/increasebuffer.py

all: Makefile.doxywizard
$(MAKE) -f Makefile.doxywizard
$(MAKE) -f Makefile.doxywizard LEX=$(LEX) PYTHON=$(PYTHON) INCBUFSIZE="$(INCBUFSIZE)"

Makefile.doxywizard: doxywizard.pro
$(QMAKE) doxywizard.pro -o Makefile.doxywizard
Expand All @@ -28,6 +29,11 @@ distclean: Makefile.doxywizard
$(MAKE) -f Makefile.doxywizard distclean
$(RM) Makefile.doxywizard

realclean: Makefile.doxywizard
$(RM) configdoc.cpp
$(RM) config_doxyw.cpp
$(MAKE) distclean

install:
$(INSTTOOL) -d $(INSTALL)/bin
$(INSTTOOL) -m 755 ../../bin/doxywizard $(INSTALL)/bin
Expand Down
Loading

0 comments on commit ac2cd57

Please sign in to comment.