4efcbab332
This is a mega-commit - because most of it had to be done in one go otherwise some commits would fail to compile - that attempts to fix a few problems with Geany's includes as well as various other related cleanups. After this change it's easier to use includes and there's little worry about which order things are included in or who includes what. Overview of changes: * Include config.h at the start of each source file if HAVE_CONFIG_H is defined (and never in headers). * Go through each source file and make the includes section generally like this: - Always config.h first as above - Then if the file has a header with the same name, include that - Then include in alphabetical order each other internal/geany header. - Then include standard headers - Then include non-standard system headers - Then include GLib/GTK+ related stuff * Doing as above makes it easier to find implicit header include dependencies and it exposed quite a few weird problems with includes or forward declarations, fix those. * Make geany.h contain not much besides some defines. - Add a little header file "app.h" for GeanyApp and move it there - Move "app" global to new "app.h" file - Move "ignore_callback" global to "callbacks.h" - Move "geany_object" global to "geanyobject.h" * Add an include in "geany.h" for "app.h" since GeanyApp used to be defined there and some plugins included this header to access GeanyApp. * Include "gtkcompat.h" everywhere instead of gtk/gtk.h so that everywhere sees the same definitions (not a problem in practice AFAIK so this could be changed back if better that way. * Remove forward declarations from previous commits as some people apparently consider this bad style, despite that it reduces inter- header dependencies. TODO: * As always, to test on win32 * As always, to test with not Autotools * Test plugins better, both builtin and geany-plugins, likely API/ABI bump * Test with various defines/flags that may change what is included * win32.[ch] not really touched since I couldn't test
Geany - A fast and lightweight IDE ---------------------------------- About ----- Geany is a small and lightweight integrated development environment. It was developed to provide a small and fast IDE, which has only a few dependencies from other packages. Another goal was to be as independent as possible from a special Desktop Environment like KDE or GNOME. So it is using only the GTK2 toolkit and therefore you need only the GTK2 runtime libraries to run Geany. Features -------- The basic features of Geany are: - syntax highlighting - code completion - auto completion of often used constructs like if, for and while - auto completion of XML and HTML tags - call tips - folding - many supported filetypes like C, Java, PHP, HTML, Python, Perl, Pascal - symbol lists - embedded terminal emulation Requirements ------------ For compiling Geany yourself, you will need the GTK (>= 2.16.0) libraries and header files. You will also need its dependency libraries and header files, such as Pango, Glib and ATK. All these files are available at http://www.gtk.org. Furthermore you need, of course, a C compiler and the Make tool; a C++ compiler is also needed for the required Scintilla library included. The GNU versions of these tools are recommended. Installation ------------ Installing Geany is done by the following three commands: $ ./configure $ make (as root) % make install For more configuration details run $ ./configure --help If there are any errors during compilation, check your build environment and try to find the error, otherwise contact the mailing list or one of the authors. See the manual for details (geany.txt/geany.html). Usage ----- To run Geany just type $ geany on a console or use the applications menu from your desktop environment. There a few command line options. See the manual page of Geany or run $ geany --help for details. Or look into the documention in the doc/ directory. The most important option probably is -c or --config, where you can specify an alternate configuration directory. Windows ------- Geany runs also under Windows. To download the binary with all necessary files, visit Geany's homepage. But you should know, that the Windows version is not yet well tested and there are some features missing: - build support (implemented but might be still buggy) - embedded terminal emulation (VTE) - Windows 9x users: in order to run Geany on Windows 95, 98 or ME you need to install the file SHFolder.dll either in the Geany installation directory or in your Windows directory. For more information please visit http://support.microsoft.com/kb/241733. License ------- Geany is distributed under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. A copy of this license can be found in the file COPYING included with the source code of this program. The included Scintilla library (found in the subdirectory scintilla/) has its own license, which can be found in the file scintilla/License.txt included with the source code of this program. Ideas, questions, patches and bug reports ----------------------------------------- See http://www.geany.org/ If you add something, or fix a bug, please send a patch (in 'diff -u' format) to the mailing list or one of the authors. Also see the HACKING file. -- 2005-2014 by Enrico Tröger, Nick Treleaven, Colomban Wendling, Matthew Brush and Frank Lanitz enrico(dot)troeger(at)uvena(dot)de nick(dot)treleaven(at)btinternet(dot)com lists(dot)ban(at)herbesfolles(dot)org mbrush(at)codebrainz(dot)ca frank(at)frank(dot)uvena(dot)de