1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
|
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<!-- Bootstrap CSS -->
<link href="styles.css" rel="stylesheet" type="text/css" />
<link href="favicon.ico" rel="shortcut icon" type="image/x-icon" />
<title>Artistic Style - Installation</title>
<script type="text/javascript">
// the <button> is described in the <body> section
window.onscroll = function () { scrollFunction() };
// When the user scrolls down 400px from the top of the document, show the button
function scrollFunction() {
if (document.body.scrollTop > 400 || document.documentElement.scrollTop > 400) {
document.getElementById("topBtn").style.display = "block";
} else {
document.getElementById("topBtn").style.display = "none";
}
}
// When the user clicks on the button, scroll to the top of the document
// Changed to scroll to "Contents" instead of "Top".
function topFunction() {
//document.body.scrollTop = 0;
//document.documentElement.scrollTop = 0;
var scroll_element = document.getElementById("Contents");
scroll_element.scrollIntoView();
}
</script>
</head>
<body id="Contents">
<div id="slogan">Artistic Style Installation</div>
<button onclick="topFunction()" id="topBtn" title="Go to Contents"><span class="menu-arrow">▲</span>
<b>Top</b></button>
<label for="responsive-button" class="responsive-button">Artistic Style Installation</label>
<input type="checkbox" id="responsive-button" role="button">
<nav class="menu">
<ul>
<li><a href="#_Artistic_Style_Versions">Packages</a>
<ul>
</ul>
</li>
<li><a href="#_Linux_Version">Linux <span class="menu-arrow">▼</span></a>
<ul>
<li><a href="#_CMake_Linux">CMake</a></li>
<li><a href="#_GCC_Makefile">GCC Makefile</a></li>
<li><a href="#_Clang_Makefile">Clang Makefile</a></li>
<li><a href="#_Intel_Makefile">Intel Makefile</a></li>
</ul>
</li>
<li><a href="#_MacOS_Version">MacOS <span class="menu-arrow">▼</span></a>
<ul>
<li><a href="#_CMake_MacOS">CMake</a></li>
<li><a href="#_MacOS_Makefile">Makefile</a></li>
<li><a href="#_Xcode">XCode</a></li>
</ul>
</li>
<li><a href="#_Windows_Version">Windows <span class="menu-arrow">▼</span></a>
<ul>
<li><a href="#_Precompiled_Executable">Precompiled</a></li>
<li><a href="#_CMake_Windows">CMake</a></li>
<li><a href="#_Visual_Studio">Visual Studio</a></li>
</ul>
</li>
<li><a href="">Other <span class="menu-arrow">▼</span></a>
<ul>
<li><a href="#_Other_Makefile_Targets">Makefile Targets</a></li>
<li><a href="#_Other_Development_Environments">Other Development Environments</a></li>
</ul>
</li>
<li><a href="#_Compiler_Options">Compiler Options</a>
<ul>
</ul>
</li>
<li><a href="#_PIP">Python PIP</a>
<ul>
</ul>
</li>
</nav>
<div style="margin-left: 2em;margin-top: 1em;">
<h3 id="_Artistic_Style_Versions" style="margin-top: 1em;">Available Packages</h3>
<p>
<strong>Linux</strong> (astyle_x.x.tar.bz2): Source code, documentation, and makefiles for compiling.<br>
<strong>Windows</strong> (astyle_x.x.zip): Source code, documentation, and pre-built executable.<br>
<strong>Windows 64-bit</strong> (astyle_x.x_x64.zip): Source code, documentation, and pre-built executable for 64-bit systems.
</p>
<h3 id="_Linux_Version">Linux Version</h3>
<h4 id="_CMake_Linux">CMake Linux</h4>
<p>
Artistic Style has CMake support for GCC, Clang, and Intel compilers. Other compilers will probably work if
the necessary options are set. Refer to the section on <a href="#_Compiler_Options">Compiler Options</a> for
more information.</p>
<p>
Since the different builds use the same source files an "out of source" build should be used. The
default build is a release version. A debug version must be specifically requested. The following options
are available for building the various configurations.
</p>
<ul>
<li>The default builds the Artistic Style command line executable (astyle). </li>
<li>BUILD_SHARED_LIBS=ON builds the Artistic Style program as a shared object (libastyle.so). </li>
<li>BUILD_JAVA_LIBS=ON builds the Artistic Style program as a shared object (libastylej.so) that can be
called
from a Java program. The Java Development Kit (JDK) must be installed for the project to compile. CMake
will
look for the JDK in the Java default folder or in a system path. If the files cannot be found, use the
variable
JAVA_HOME=<Java Directory> with the path into the top level Java folder.</li>
<li>BUILD_STATIC_LIBS=ON builds the Artistic Style program as a Static Library (libastyle.a) that can be
statically linked to a user program.</li>
</ul>
<h5>EXAMPLES</h5>
<p>
The following examples are assumed to be run from the astyle directory that contains
CMakeLists.txt. They show out of source builds that generate makefiles.</p>
<p>
To build the console release version:</p>
<pre>mkdir as-gcc-exe
cd as-gcc-exe
cmake ../
make
</pre>
<p>
To build the shared debug version:</p>
<pre>mkdir --parents as-gcc-so
cd as-gcc-so
cmake -DBUILD_SHARED_LIBS=ON -DCMAKE_BUILD_TYPE=Debug ../
make
</pre>
<p>
To build the Java release version using the Clang compiler and the JAVA_HOME variable:</p>
<pre>mkdir as-clang-java
cd as-clang-java
CXX=clang++ cmake -DBUILD_JAVA_LIBS=ON -DJAVA_HOME="C:/Programs/Java" ../
make
</pre>
<h5>INSTALL</h5>
<p>
The makefile install option installs the astyle executable and documentation files. The option installs from
the generated makefile, not CMake. You must have the appropriate permissions to use install. </p>
<p>
To install astyle:</p>
<pre>make install</pre>
<p>
The default install directory is /usr/local/bin for the executable and /usr/local/share/doc/astyle for the
documentation. To change the default install directory from /usr/local the CMake must be run with the option
CMAKE_INSTALL_PREFIX. </p>
<p>
To run CMake and change the install directory:</p>
<pre>cmake -DCMAKE_INSTALL_PREFIX=/usr ../
make install</pre>
<h5>UNINSTALL</h5>
<p>
There is no uninstall. The easiest way to uninstall is to use the install_manifest.txt file, for example
"<strong>xargs rm < install_manifest.txt</strong>".
</p>
<h4 id="_GCC_Makefile">GCC Makefile</h4>
<p>
To compile using the GCC compiler you must have GCC (3.1 or better) installed.
</p>
<p>
The build has no autoconf dependency. To build the Artistic Style configurations, use the makefile located
in the astyle/build/gcc directory. The executables will be in the astyle/build/gcc/bin directory. To build the
command line configuration, enter the following:
</p>
<pre>cd astyle/build/gcc<br />make
</pre>
<p>
To build the other astyle configurations, you can enter the file name or a symbolic name. Entering "make
astyle" or "make release" will build the command line configuration. Following are the symbolic names and file names
(in parens) of the various configurations:</p>
<ul>
<li><strong>release</strong> or <strong>astyle</strong> builds the Artistic Style command line program. This
is the
default option. </li>
<li><strong>shared</strong> or <strong>libastyle.so</strong> builds the Artistic Style program as a shared
library. </li>
<li><strong>static</strong> or <strong>libastyle.a</strong> builds the Artistic Style program as a static
library. </li>
<li><strong>debug</strong> or <strong>astyled</strong> builds the Artistic Style command line program with
debugging
information </li>
<li><strong>shareddebug</strong> or <strong>libastyled.so</strong> builds the Artistic Style program as a
shared library
with debugging information. </li>
<li><strong>staticdebug</strong> or <strong>libastyled.a</strong> builds the Artistic Style program as a
static library
with debugging information. </li>
<li><strong>all</strong> builds all the above configurations.
<p>
The following Java shared library builds are separate from the above. They include a Java Native
Interface (JNI)
and require that the Java Development Kit (JDK) be installed. The environment variable JAVA_HOME
should be defined.
It defines the install directory for the JDK. If the compile cannot find the file jni.h, either set
the JAVA_HOME variable or change the value in the makefile.</p>
</li>
<li><strong>java </strong>builds the Artistic Style program as a shared library which includes the JNI
(libastylej.so).
</li>
<li><strong>javadebug </strong>builds the Artistic Style program as a shared library which includes the JNI
and debugging
information
(libastylejd.so).</li>
<li><strong>javaall </strong>builds all the above java configurations.</li>
</ul>
<p>
More than one configuration can be built at the same time. For example, to build all the release
configurations enter:</p>
<pre>cd astyle/build/gcc<br />make release shared static</pre>
<p>
The <a href="#_Other_Makefile_Targets">Other Makefile Targets</a> section contains additional target
options.</p>
<h4 id="_Clang_Makefile">Clang Makefile</h4>
<p>
Clang has a static analyzer that finds potential bugs in C/C++ and <span style="white-space: nowrap;">
Objective-C</span> programs. It can be run as a standalone tool from the command-line and runs in tandem with
a build. There is a script file, analyze.sh, that will run the analysis on Artistic Style.</p>
<p>
The build has no autoconf dependency. To build the Artistic Style configurations use the makefile located in the
astyle/build/clang directory. The executables will be in the astyle/build/clang/bin directory. To build the
command line configuration, enter the following:</p>
<pre>cd astyle/build/clang<br />make
</pre>
<p>
To build the other astyle configurations, you can enter the file name or a symbolic name. The configurations for
Clang are the same as for the <a href="#_GCC_Makefile">GCC Makefile</a>. More than one configuration can be
built at the same time. For example, to build all the release configurations enter:</p>
<pre>cd astyle/build/clang<br />make release shared static
</pre>
<p>
The <a href="#_Other_Makefile_Targets">Other Makefile Targets</a> section contains additional target
options.</p>
<h4 id="_Intel_Makefile">Intel Makefile</h4>
<p>
These procedures and the makefile are for recent versions of the compiler. They may not work for earlier
versions. Instructions for your compiler are in the compiler documentation file "get_started_lc.htm".</p>
<p>
To compile with Intel there are environment variables that must be set by running the compiler environment
script compilervars.sh (or compilervars.csh) with an argument that specifies the target architecture. This
should be done before running the make. If it is not done, "make" will display an error message
stating that the compiler environment variables are not set.</p>
<p>
The build has no autoconf dependency. To build the Artistic Style configurations use the makefile located in
the astyle/build/intel directory. The output executables will be in the astyle/build/intel/bin directory. To
build the command line configuration, enter the following:</p>
<pre>cd astyle/build/intel<br />make</pre>
<p>
To build the other astyle configurations, you can enter the file name or a symbolic name. The configuration
names for Intel are the same as for the <a href="#_GCC_Makefile">GCC Makefile</a>. More than one configuration can
be built at the same time. For example, to build the entire debug configurations enter:</p>
<pre>cd astyle/build/intel<br />make debug shareddebug staticdebug</pre>
<p>
The <a href="#_Other_Makefile_Targets">Other Makefile Targets</a> section contains additional target
options.</p>
<p>
For other Linux development environments, follow the instructions in <a
href="#_Other_Development_Environments">Other
Development Environments</a>.</p>
<h3 id="_MacOS_Version">MacOS Version</h3>
<h4 id="_CMake_MacOS">CMake MacOS</h4>
<p>
Artistic Style has CMake support for MacOS. It is used the same as <a href="#_CMake_Linux">CMake Linux</a>
except the supported compilers are only GCC and Clang. The macOS default installs will be to /usr/local
instead of /usr.</p>
<h4 id="_MacOS_Makefile">MacOS Makefile</h4>
<p>
The Artistic Style makefile compile uses the Mac OS "Command Line Tools". If you have Xcode 4.3 or
newer the command line tools, such as "make", are NOT installed by default. They must be downloaded and
installed separately. Once everything is successfully installed, you should see "make" and other command
line developer tools in /usr/bin.</p>
<p>
The build has no autoconf dependency. To build the Artistic Style configurations use the makefile located in the
astyle/build/mac directory. The executables will be in the astyle/build/mac/bin directory. To build the
command line configuration, enter the following:</p>
<pre>cd astyle/build/mac<br />make
</pre>
<p>
To build the other astyle configurations, you can enter the file name or a symbolic name. The configurations
for
Mac are the same as for the <a href="#_GCC_Makefile">GCC Makefile</a>. More than one configuration can be
built at the same time. For example, to build all the release configurations enter:</p>
<pre>cd astyle/build/mac<br />make release shared static
</pre>
<p>
The <a href="#_Other_Makefile_Targets">Other Makefile Targets</a> section contains additional target
options.
The macOS default installs will be to /usr/local instead of /usr.</p>
<h4 id="_Xcode">Xcode</h4>
<p>
Artistic Style workspace and project files for the Xcode development environment are available in the
"build/xcode"
directory. A workspace can be used to build a single project or all the projects. The project files have
Debug
and Release configurations. The following projects are available.</p>
<ul>
<li><strong>AStyle</strong> builds the Artistic Style command line program (astyle). </li>
<li><strong>AStyleA</strong> builds the Artistic Style program as a Static Library (libastyle.a). This can
be statically
linked with an executable.</li>
<li><strong>AStyleDylib</strong> builds the Artistic Style program as a Dynamic Library (libastyle.dylib).
It can
be used with C/C++, <span style="white-space: nowrap;">Objective-C</span>, C#, and Python programs.</li>
<li><strong>AStyleJava</strong> builds the Artistic Style program as a Dynamic Library (libastylej.dylib)
that can be called from a Java program. The Java Development (JDK) is required for the project to compile. The
Project Properties must have an include path to the JDK include directory. The output dylib can also be called
from a C++ or C# program.</li>
</ul>
<h5>INSTALL</h5>
<p>
Only the astyle executable is installed. The library project installs are sent to UninstalledProjects in
the Build directory. The following instructions are for the astyle executable and documentation files. The
default
install directory is /usr/local/bin for the executable and /usr/local/share/doc/astyle for the
documentation.
You must have the appropriate permissions to use install. If sudo is not used for the install, an error will
occur during the build.</p>
<p>
To install the astyle executable in the default directory:</p>
<pre>cd astyle/build/xcode
sudo xcodebuild install -project AStyle.xcodeproj
</pre>
<p>A script is used to install the documentation from the same directory.</p>
<pre>sudo bash install.sh
</pre>
<h5>UNINSTALL</h5>
<p>
Uninstalls the executable and documentation. You must have the appropriate permissions to use uninstall.</p>
<p> A script is used to uninstall astyle and the documentation:</p>
<pre>sudo bash uninstall.sh
</pre>
<p>
NOTE: The uninstall option will NOT remove the .astylerc files from the users' home directories. The files
must
be removed individually for each user.</p>
<h3 id="_Windows_Version">Windows Version</h3>
<h4 id="_Precompiled_Executable">Precompiled Executable</h4>
<p>
In addition to the source files, the Windows distribution package contains an Artistic Style Win32
executable
(AStyle.exe). If you prefer to compile the executable yourself, use the following instructions.</p>
<h4 id="_CMake_Windows">CMake Windows</h4>
<p>
Artistic Style has CMake support for Borland, and MinGW compilers. Other compilers will probably work if
the necessary options are set. Refer to the section on <a href="#_Compiler_Options">Compiler Options</a> for
more information.</p>
<p>
The console executable will run for both of the supported compilers. The DLL builds may not. CMake does not
fully support all Windows compilers. To build the DLLs it would be best to generate an IDE project file and
compile the DLLs with the IDE. The "build" folder contains project files for CodeBlocks and Visual
Studio.
</p>
<p>
Since the different builds use the same source files an "out of source" build should be used. The
default build for MinGW is a release version. A debug version must be specifically requested. For
Borland, a release build may need to be specifically requested, depending on the CMake release used. Borland
has been tested with the bcc32c free compiler. It may or may not work with other Borland compilers. The
following
options are available for building the various configurations.</p>
<ul>
<li>The default builds the Artistic Style command line executable (AStyle.exe). </li>
<li>BUILD_SHARED_LIBS=ON builds the Artistic Style program as a DLL (AStylexx.dll, where xx is the astyle
release
number). </li>
<li>BUILD_JAVA_LIBS=ON builds the Artistic Style program as a DLL (AStylexxj.dll, where xx is the astyle
release
number) that can be called from a Java program. The Java Development Kit (JDK) must be installed for the
project
to compile. CMake will look for the JDK in the Java default folder or in a system path. If the files
cannot be
found, use the variable JAVA_HOME=<Java Directory> with the path into the top level Java folder.
</li>
<li>BUILD_STATIC_LIBS=ON builds the Artistic Style program as a Static Library (AStyleLib.lib) that can be
statically linked to a user program.</li>
</ul>
<h5>EXAMPLES</h5>
<p>
The following examples are assumed to be run from the astyle directory that contains
CMakeLists.txt. They show out of source builds that generate makefiles. </p>
<p>
A path to the compiler executable
may need to be declared before compiling. And the Borland free compiler will need the compiler name.
To set the variables before compiling (replace the path names with the paths on your computer):</p>
<pre>set PATH=C:\Program Files\CMake\bin;%PATH%
set PATH=C:\Program Files (x86)\Embarcadero\BCC101\bin;%PATH%
set CXX=bcc32c
</pre>
<p>
To build the Borland console release version (the release build may need to be specified):</p>
<pre>md as-bcc32c-exe
cd as-bcc32c-exe
cmake -G "Borland Makefiles" -DCMAKE_BUILD_TYPE=Release ../
make
</pre>
<p>
To build the MinGW Java release version using the JAVA_HOME variable:</p>
<pre>md as-mingw-exe
cd as-mingw-exe
cmake -G "MinGW Makefiles" -DBUILD_JAVA_LIBS=ON -DJAVA_HOME="C:/Programs/Java" ../
mingw32-make</pre>
<p>As stated previously, the DLL builds may not work with the CMake generated makefiles.</p>
<h5>INSTALL</h5>
<p>
The makefile install option installs the astyle executable and documentation files. The default is
"C:\Program
Files\AStyle" for the executable and "C:\Program Files\AStyle\doc" for the documentation.
You may need to run as an administrator to install. </p>
<h5>UNINSTALL</h5>
<p>
There is no uninstall. The uninstall must be done manually. Just remove the
AStyle folder indicated in the
Install. </p>
<h4 id="_Visual_Studio">Visual Studio</h4>
<p>
There are solution and project files for several versions of Microsoft Visual Studio. Open an Artistic Style
solution
file in the appropriate "build" directory. All projects have Debug, Release and Static
configurations.
Debug file output will be in the "debug" directory. Release file output will be in the
"bin"
directory. Static file output will be in the "binstatic" directory. The following solution files are
available.</p>
<ul>
<li><strong>All AStyle </strong>builds the release and the debug configurations for all the following.
</li>
<li><strong>AStyle </strong>builds the Artistic Style command line program (AStyle.exe). This project has an
extra
"Static"" option. It is the same as the "Release" build except that it is linked
with a static
runtime library. This is needed if the executable is to be run on a system without Visual Studio
installed. The
builds for this configuration are placed in a separate "binstatic" directory. </li>
<li><strong>AStyle Dll </strong>builds the Artistic Style program as a Dynamic Link Library (AStyle.dll).
This will
also build an export library and a static library for linking the dll. </li>
<li><strong>AStyle Java </strong>builds the Artistic Style program as a Dynamic Link Library (AStylej.dll)
that can
be called from a Java program. The Java Development (JDK) is required for the project to compile. The
Project
Properties must have an include path to the JDK include and include/win32 directories. This is set in
"Project
> Properties > C/C++ > General > Additional Include Directories". The default
setting
is for the JDK to be installed in the default directory, but it may not be the most current release. The
output
DLL can also be called from a C++ or C# program.</li>
<li><strong>AStyle Lib </strong>builds the Artistic Style program as a Static Library (libAStyle.lib). This
can be
statically linked to a calling program.</li>
</ul>
<p>
For other Windows development environments, follow the instructions in <a
href="#_Other_Development_Environments">
Other Development Environments</a>.</p>
<h3 id="_Other_Makefile_Targets">Other Makefile Targets</h3>
<p>
The following makefile targets are available for GCC, Clang, Intel, and Mac.</p>
<h5>CLEAN</h5>
<p>
Removes the object and executable files for all configurations.</p>
<p>
To remove the files for all configurations:</p>
<pre>make clean
</pre>
<h5>CLEANOBJ</h5>
<p>
Removes the object files for all configurations. The executables will not be removed.</p>
<p>
To remove only the object files for all configurations:</p>
<pre>make cleanobj
</pre>
<h5>INSTALL</h5>
<p>
Installs the astyle executable and documentation files. The default is /usr/bin for the executable and
/usr/share/doc/astyle
for the documentation. You must have the appropriate permissions to use install.</p>
<p>
To install the astyle to the default directories:</p>
<pre>sudo make install
</pre>
<p>
To install astyle to a different bin directory set a value for the macro $(prefix). For example, to install
the
executable to a user's home directory (/home/<i>user</i>/bin):</p>
<pre>sudo make prefix=$HOME install
</pre>
<h5>UNINSTALL</h5>
<p> Uninstalls the executable and documentation. You must have the appropriate permissions to use uninstall.</p>
<p> To uninstall astyle from the default directories:</p>
<pre>sudo make uninstall
</pre>
<p>
To uninstall the files from a different directory set a value for the macro $(prefix). For example, to
uninstall
the files from a user's home directory (/home/<i>user</i>):</p>
<pre> sudo make prefix=$HOME uninstall
</pre>
<p>
NOTE: The uninstall option will NOT remove the .astylerc files from the users' home directories. The files
must
be removed individually for each user.</p>
<h3 id="_Other_Development_Environments">Other Development Environments</h3>
<p>
To use other development environments project files usually must be built. CMake can be used if the
development
environment is supported. Otherwise, use the development environment to create files.</p>
<ul>
<li>Create a project using the development environment.</li>
<li>Add to the project all the .cpp and .h files in the "src" directory.</li>
<li>The Compiler Options section discusses the compiler options to use.</li>
<li>Compile.</li>
</ul>
<h3 id="_Compiler_Options">Compiler Options</h3>
<p>
No macro definitions are required to compile the executable. To compile as a static or shared (dynamic)
library
define the macro ASTYLE_LIB. To compile a Java shared (dynamic) library define the macro ASTYLE_JNI. The
option ASTYLE_NO_EXPORTS is sometimes needed for static libraries to prevent compiler error and warning
messages. Use the appropriate compiler and linker options to compile the static or shared library. Add debug
options to compile the debug versions.</p>
<p>
Artistic Style is a small program and it is best to optimize for speed. The debug configurations are not
usually
optimized. To optimize for speed in the release configurations, use the macro NDEBUG to remove asserts. If
necessary, use an option to activate the C++17 standards (-std=c++17 on most compilers). Use an
option that allows inline function expansion. Runtime Type Information (RTTI) is NOT needed and exceptions
are NOT used. Use whole program optimization if your compiler supports it. </p>
<h3 id="_PIP">Python PIP</h3>
<p>
There are two projects which enable astyle installation using PIP: <a
href="https://github.com/Freed-Wu/astyle-wheel/">astyle-wheel</a> and <a
href="https://github.com/igrr/astyle_py">astyle_py (using WASM)</a>.<br>
These are useful to be included in git pre-commit hooks.
</p>
<p style="margin-left: -0.4in; text-align: center;">
<a href="http://sourceforge.net/projects/astyle">
Artistic Style on SourceForge.net
</a>
</p>
</div>
</div>
</body>
</html>
|
