Mercurial > hg > forks > UniversalIndentGUI

annotate README_older_but_worth_reading.txt @ 801:71b89219671c default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix Debian package rules for Qt5 build.
author Matti Hamalainen <ccr@tnsp.org>
date Fri, 13 Apr 2018 02:02:51 +0300
parents 2a9bb3774867
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
546
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
1 UniversalIndentGUI
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
2 ==================
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
3
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
4 This application is released under the GPL version 2. Read the file "LICENSE.GPL" in the same directory as this readme for more information or have a look at http://www.gnu.org/licenses/gpl.html!
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
5
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
6
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
7 1. About UniversalIndentGUI
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
8 ---------------------------
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
9
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
10 The UniversalIndentGUI is a universal graphical user interface for source code respective text formatters, beautifiers and indenters. This is mainly achieved by a configuration file for each supported indenter.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
11
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
12 One of the main features and the reason why this tool was (better is being) developed is to see how the indent parameters affect the source code style, directly while changing the parameters. It always bothered me to change one option of a tool like GNU Indent or GreatCode and have to run it to see what my code would look like afterward. Often the result was not what I expected from the parameters description. So these times are gone. Toggle a parameter and see what it does.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
13
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
14
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
15 2. Features
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
16 -----------
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
17 - Supports the following indenters:
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
18 * Artistic Styler
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
19 * BCPP
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
20 * Cobol Beautifier
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
21 * CSS Tidy
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
22 * GNU Indent
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
23 * GreatCode
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
24 * HIndent
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
25 * HTB
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
26 * JsDecoder
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
27 * Perl Tidy
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
28 * PHP Beautifier
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
29 * phpCB
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
30 * PHP Stylist
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
31 * Ruby Beautify
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
32 * Ruby Formatter
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
33 * Shell Indent
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
34 * (HTML) Tidy
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
35 * Uncrustify
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
36
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
37 - By these indenters the following programming languages are supported:
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
38 C, C++, C#, Cobol, CSS, D, HTML, JAVA, Javascript, ObjectiveC, Pawn, Perl, PHP, Ruby, Shellscript, VALA, XML and XSL.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
39
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
40 - Directly see how the code/text is affected by a indenter parameter
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
41
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
42 - Load a source code file of your choice as test file
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
43
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
44 - Indenter settings can be saved into the indenters own config file format (in case of GreatCode this is for example the file "gc.cfg")
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
45
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
46 - Create shell/batch scripts which make it easy to format whole directories with the selected indenters settings. Also these scripts can be called from within every application.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
47
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
48 - Not yet known indenters can be added by creating a ini file for them, that is used by UniversalIndentGUI (this file has the prefix "uigui_" and ends with ".ini"). Have a look at the file "doc/iniFileFormat.html" for explanations about the ini file format. If you want to extend an existing or create a new ini file for a new indenter, you are sincerely invited to do so and I would be thankful for telling me about it.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
49
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
50
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
51 3. Starting UniversalIndentGUI
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
52 ------------------------------
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
53
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
54 UniversalIndentGUI does not need any further libs or dlls if you got one of the binary archives, because it is linked statically. Thats the reason why the binary file is rather big.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
55
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
56 These binary archives (I mean the zip and tgz files) contain all supported indenters except for phpCB, because it must be obtained with acceptance of its owners.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
57
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
58 Right now the windows version of GreatCode is shipped along with the Linux version of UniversalIndentGUI, because I was unable to compile GreatCode under Linux. UniversalIndentGUI tries to start GreatCode via wine. So wine has to be installed in order to use GreatCode. This applies to any new indenter, where only a windows executable exists, too.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
59
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
60 3.1 Parameters
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
61 UniversalIndentGUI can be started with different parameters. The mentioned server component is currently in a very early development state. Its intention is to open UiGUI for plugins that can communicate from for example any editor via TCP/IP with the indenting component. Later more about that.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
62
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
63 The following parameters can be used:
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
64 No parameters starts without server and full gui.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
65 -f filename --file filename : Opens the by filename defined file on start.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
66 -p --plugin : Run as plugin. Server will be startet with a simplified gui.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
67 -s --server : Run as server only without gui.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
68 If -p and -s are set, -p will be used.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
69
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
70 3.2 Portable mode
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
71 UniversalIndentGUI can be run in a portable mode, so it won't make any modifications on the system, except for the media it is started from. The things UniversalIndentGUI writes to the for example USB drive are the user settings of the application and the set parameters of the indenters. Further a temporary dir is used, to feed the indenters with input files and grab their output.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
72 The portable mode is being used, if the sub dir "indenters" is found in the same dir as the executable. Thats the case for the before named binary archives.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
73
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
74 3.3 Multiuser mode
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
75 Especially Unix based systems strictly make use of user restrictments, but also Windows can be used that way, even if many dislike that due to lack of comfort. To be able to run UniversalIndentGUI on multiuser systems the needed files are spread over different directories. On Unix based these are:
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
76 /usr/bin for the binary.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
77 /etc/UniversalIndentGUI for global configuration and the essential indenter ini files.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
78 /usr/share/man/man1 for the zipped man page.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
79 ~/.config/UniversalIndentGUI for the users application and indenter settings.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
80
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
81 Similar on Windows:
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
82 %ProgramFiles%\UniversalIndentGUI for the binary and all other needed files, like global configuration and the essential indenter ini files.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
83 %APPDATA%\UniversalIndentGUI for the users application and indenter settings.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
84
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
85 The multiuser mode is used by default, if no "indenters" sub dir is found in the same dir as the executable.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
86
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
87
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
88 4. Compile UniversalIndentGUI from source
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
89 -----------------------------------------
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
90
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
91 The latest version of the project can be downloaded via subversion.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
92 Server: https://universalindent.svn.sourceforge.net
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
93 Repository: svnroot/universalindent
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
94 Directory: trunk
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
95 As one path: https://universalindent.svn.sourceforge.net/svnroot/universalindent/trunk
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
96
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
97 The Qt Framework Version >=4.4.x with source code is needed for compiling. It is available at www.trolltech.com. Please look there for more information. And pay attention, that there exist a commercial and a free GPL version of the Qt framework.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
98
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
99 The second needed library comes from the QScintilla project (http://www.riverbankcomputing.co.uk/qscintilla/). Since I am using Qt4 there is also need to use the Qt4 version of QScintilla which is called QScintilla v2. The latest version is allways available at http://www.riverbankcomputing.com/software/qscintilla/download and most of the time there is no problem using that snapshot.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
100
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
101 For the Windows Visual Studio 2005 a solution file is included, named "UniversalIndentGUI.sln". Additional include and lib directories for Qt have to be set in the preferences. Have a look at the homepage "http://wiki.qgis.org/qgiswiki/Building_QT_4_with_Visual_C++_2005", where you will find a good guide how to make Qt's open source edition compileable with Visual Studio. Even though it is written for Qt 4.1.1 it also fits for the current version 4.x.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
102
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
103 Instead of using Visual Studio the qmake project file can be used to compile on any platform. Just run "qmake" in the projects main directory (where the file "UniversalIndentGUI.pro" resides). After this run "make debug" or "make release". That should do it.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
104
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
105 The make directive to install UniversalIndentGUI is right now only completed for Unix based systems and can be called by "sudo make install".
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
106
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
107 When compiling has successfully completed you also need to "compile" the existing language translation files in the directory "translations". This is done by calling "lrelease filename.ts -qm filename.qm". "filename" has to be replaced by the real existing filename.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
108
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
109
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
110 5. How to integrate an indenter written in JavaScript
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
111 -----------------------------------------------------
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
112 Since version 0.8.0 it is possible to use indenters that are written in JavaScript. These are executed by UniversalIndentGUIs internal JavaScript interpreter.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
113 To write an own indenter in JavaScript that can be executed by UniversalIndentGUI, the indenter must provide two variables, with the names "unformattedCode" and "formattedCode". The exact names are mandatory. The first one must not be defined by the indenter itself, but is created by UniversalIndentGUI and is the input variable for the indenter. When called, it contains the unformatted source code. The second variable must be defined in the indenter and is the variable that returns the formatted source code.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
114 In case of the indenter JsDecoder, that is shipped along with UniversalIndentGUI, the important code lines at its end look like this:
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
115 var jsdecoder = new JsDecoder();
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
116 var formattedCode;
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
117
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
118 // Feed the indenter with unformatted code.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
119 jsdecoder.s = unformattedCode;
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
120 // Get the formatted code from the indenter.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
121 formattedCode = jsdecoder.decode();
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
122
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
123 return formattedCode;
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
124
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
125
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
126 6. Future plans
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
127 ---------------
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
128 - As mentioned above a server mode is in preparation. The protocol that will be documented when its finished.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
129
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
130 - Te whole architectue will be refactored so that the code viewing component can be flexible replaced. This is needed because I plan to integrate a diff view where the difference between original and formatted code is directly highlighted.
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
131
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
132
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
133 7. Some words at the end
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
134 ------------------------
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
135
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
136 Feel happily invited to try out and comment UniversalIndentGUI. Good and bad critics are welcome, if they are helpful of course ;-)
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
137
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
138
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
139 8. Disclaimer
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
140 -------------
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
141
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
142 You may use this software on your own risk. I am not responsible for any system damage or loss of data. Respect the GPL!
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
143
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
144
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
145 So long,
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
146
2a9bb3774867 Renamed the older readme file.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents:
diff changeset
147 Thomas