source: git/doc/HACKING.htm @ df1d579

faster-cavernloglog-selectstereo-2025walls-datawalls-data-hanging-as-warningwarn-only-for-hanging-survey
Last change on this file since df1d579 was b1c66e1, checked in by Olly Betts <olly@…>, 17 months ago

Use wx 3.2.4 for mingw build
  • Property mode set to 100644
File size: 5.6 KB
RevLine 
[e7839be]1<HTML><HEAD>
2<TITLE>Survex Hacker's Guide</TITLE>
3<STYLE type="text/css"><!--
4BODY, TD, CENTER, UL, OL {font-family: sans-serif;}
5-->
6</STYLE>
7</HEAD><BODY BGCOLOR=white TEXT=black>
8<H1>Hacking Survex</H1>
9
10<p>(That's hacking in the "tinkering with code" sense, not in the
11"breaking into other people's computer systems" sense).
12
13<p>This is currently a random collection of notes that need to be written
14down while I remember.  With time it should evolve into a more
15coherent document.  If you have any questions which this should answer
16but doesn't then ask me and I'll add them.
17
18<H2>Network code debugging</H2>
19
20<P>You can pick which network simplifications are attempted using "-z"
21with an argument listing code letters.  So:
22
23<ul>
24<li>-z=    no special simplifications (articulation still performed)
25<li>-z=l   remove "lollipops"
26<li>-z=p   remove parallel legs
27<li>-z=d   convert deltas to stars
28</ul>
29
30<P>And you can combine these in any combination:
31
32<ul>
33<li>-z=lp  remove "lollipops" and parallel legs
34<li>-z=lpd remove "lollipops" and parallel legs; convert deltas to stars
35</ul>
36
37<P>"-z=lpd" is the default (in 0.99 at least - more transformations may
38conceivably be added in future, although the simple common cases are
39already covered).
40
41<H2>Developing on Unix Platforms</H2>
42
[b63c928d]43<P>You'll need automake 1.5 or later (earlier versions don't support
[27b8b59]44per-executable CFLAGS; 1.6 has been tested and works, but wasn't a
45very stable release - automake 1.6.1 is a better bet)
[1ed5c4e]46and autoconf 2.50 or later (autoconf 2.52, 2.53, 2.64 and 2.71 have all
[9bf7aa33]47been used successfully).
[c372fc9]48
[1ed5c4e]49<p>The wxWidgets library is used for aven's UI.  Currently >= 3.0.0 is
50supported.
51
[ab24da7]52<p>The PROJ library is used for coordinate conversions.  Currently >= 6.2.0 is
[1ed5c4e]53supported.
54
55<P>The Perl Locale::PO module is used for process message translation files.
56
[d5ef6ad]57<P>For building the documentation you'll need docbook-utils (also
58known as docbook-tools) and w3m.
[e7839be]59
[29e5a96]60<P>And for building unifont.pixelfont, you'll need unifont installed.
61
62<P>On Debian, you can install the required packages using:
63
64<pre>
[1ed5c4e]65sudo apt-get install autoconf automake liblocale-po-perl libproj-dev libwxgtk3.0-gtk3-dev inkscape netpbm docbook-utils w3m unifont
[29e5a96]66</pre>
[6127c82]67
[e7839be]68<H2>Building on Non-Unix Platforms</H2>
69
[c372fc9]70<H3>Mingw (Microsoft Windows)</H3>
[e7839be]71
72<P>Currently I build this with a Linux hosted cross-compiler.  I use
[adceff5]73the packaged cross-compiler in the debian testing/unstable distribution:
74
[bd285e5a]75<pre>
76sudo apt-get install mingw-w64-i686-dev
77</pre>
[e7839be]78
[d6a770d]79<p>
80I then install the various libraries by compiling from source.  For wxWidgets
[3e85309]81I apply a
[b1c66e1]82<a href="https://survex.com/software/wxWidgets-3.2.4.patch">patch</a> to
[3e85309]83disable a pointless and annoying compiler ABI check
[38bc415]84(with this check aven stops working each time my cross compiler package is
85upgraded to a new GCC version; without it everything works fine).
[853438c]86</p>
87
88<p>
89Then I configure, build and install with:
[bd285e5a]90</p>
91
92<pre>
[b1c66e1]93./configure --prefix=/usr/i686-w64-mingw32 --host i686-w64-mingw32 --with-msw --with-opengl --enable-display --disable-shared host_alias=i686-w64-mingw32 DOCBOOK_TO_MAN="xmlto man --skip-validation"
[bd285e5a]94make
95sudo make install
96</pre>
97
98<p>
[7576825]99For sqlite (needed by PROJ):
[d6a770d]100</p>
101
[bd285e5a]102<pre>
[7576825]103wget https://www.sqlite.org/2021/sqlite-autoconf-3360000.tar.gz
104tar xvf sqlite-autoconf-3360000.tar.gz
[bd285e5a]105mkdir BUILD
106cd BUILD
[7576825]107../configure --prefix=/usr/i686-w64-mingw32 --host i686-w64-mingw32 --disable-shared --disable-fts4 --disable-fts5 --disable-json1 --disable-rtree host_alias=i686-w64-mingw32
[bd285e5a]108make
109sudo make install
110</pre>
111
112<p>
[7576825]113For PROJ 8.2.0 (TIFF apparently useful for some grids, but would also need libtiff):
114</p>
115
116<pre>
117mkdir BUILD
118cd BUILD
119../configure --prefix=/usr/i686-w64-mingw32 --host i686-w64-mingw32 --disable-shared host_alias=i686-w64-mingw32 --without-curl --disable-tiff
120make
121sudo make install
122</pre>
123
124<p>
125For ffmpeg 4.4.1:
[bd285e5a]126</p>
127
128<pre>
129sudo apt-get install yasm
130mkdir BUILD
131cd BUILD
[86801ff]132../configure --prefix=/usr/i686-w64-mingw32 --cross-prefix=i686-w64-mingw32- --enable-cross-compile --target-os=mingw32 --arch=i686 --disable-shared --disable-decoders --disable-demuxers --disable-programs --disable-network --disable-bsfs --disable-protocols --disable-devices
[bd285e5a]133make
134sudo make install
135</pre>
[d6a770d]136
[e7839be]137<P>Building on Windows in a native mingw environment will probably
138require tinkering.  Best bet is probably to install bash and use the
139current configure script.  I'm happy to help if you want to try this,
140and I'll incorporate patches provided they're fairly clean.
141
[9fe7af4f]142<H2>Microsoft Windows Installer Builder</H2>
143
144<P>We use <A HREF="http://www.jrsoftware.org/isinfo.php">InnoSetup</A> to
[9990aab]145build the MS Windows Installer.  Survex 1.4.2 was built using InnoSetup
1466.2.0.
[ebcdad9]147
148<P>Here are some random notes:
[9fe7af4f]149
[85f3565]150<H3>Packages Needed</H3>
151
[7576825]152<P>On Debian unstable/testing:
[adceff5]153
154<pre>
[8aebb0a]155sudo apt-get install wine wx3.0-i18n
[adceff5]156</pre>
157
158<P>And then run:
[85f3565]159
[adceff5]160<pre>
[9990aab]161wine ~/Downloads/innosetup-6.2.0.exe
[adceff5]162</pre>
[85f3565]163
[9fe7af4f]164<H3>Translations</H3>
165
[ebcdad9]166<P>In addition to the translations included with InnoSetup as standard, we also
[8b3362b]167add these, which you can find in the <code>lib</code> subdirectory of Survex's
[e367554]168source tree:
[9fe7af4f]169
170<UL>
[9990aab]171<li>ChineseSimplified.isl (6.1.0+)
172<li>ChineseTraditional.isl (6.1.0+)
173<li>EnglishBritish.isl (6.1.0+)
174<li>Greek.isl (6.1.0+)
175<li>Hungarian.isl (6.1.0+)
176<li>Indonesian.isl (6.1.0+)
177<li>Romanian.isl (5.5.3+)
[9fe7af4f]178</UL>
179
[9990aab]180These are taken from the <a href="https://jrsoftware.org/files/istrans/">Inno
181Setup Translations</a> page.
[317c11b]182
[9fe7af4f]183<H3>survex.iss</H3>
184
185<P>This file is generated by configure (from the template survex.iss.in).
186We could instead have a static survex.iss which uses #include to pull in
187a file with the Survex version info in, but the current method works well
188enough so we'll stick with it for now (I suspect #include was introduced since
189we started using InnoSetup).
190
[e7839be]191</BODY></HTML>
Note: See TracBrowser for help on using the repository browser.