Use `%NULL`, `%FALSE` and `%TRUE` in the GtkDoc output
[geany-mirror.git] / HACKING
blob9ae47ebba400a7aab1b37d1957efaa8c72a9410c
1 =============
2 Hacking Geany
3 =============
4 .. contents::
6 General
7 =======
9 About this file
10 ---------------
11 This file contains information for anyone wanting to work on the Geany
12 codebase. You should be aware of the open source licenses used - see
13 the README file or the documentation. It is reStructuredText; the
14 source file is HACKING.
16 You can generate this file by:
18 * Passing the *--enable-html-docs* option to ``configure``.
19 * Running ``make`` from the doc/ subdirectory.
21 Writing plugins
22 ---------------
23 * src/plugindata.h contains the plugin API data types.
24 * See plugins/demoplugin.c for a very basic example plugin.
25 * src/plugins.c loads and unloads plugins (you shouldn't need to read
26   this really).
27 * The API documentation contains a few basic guidelines and hints to
28   write plugins.
30 You should generate and read the plugin API documentation, see below.
32 Plugin API documentation
33 ^^^^^^^^^^^^^^^^^^^^^^^^
34 You can generate documentation for the plugin API using the doxygen
35 tool:
37 * Pass the *--enable-api-docs* option to ``configure``.
38 * Run ``make`` from the doc/ subdirectory.
40 The documentation will be output to doc/reference/index.html.
41 Alternatively you can view the API documentation online at
42 http://www.geany.org/manual/reference/.
44 Pull requests
45 -------------
46 Making pull requests on Github is the preferred way of contributing for geany.
48 .. note:: For helping you to get started: https://help.github.com/articles/fork-a-repo
50 See `Rules to contribute`_ for more information.
52 Patches
53 -------
54 We are happy to receive patches, but the preferred way is to make a pull
55 request on our Github repository. If you don't want to make a pull request,
56 you can send your patches on the devel mailing list, but the rules are the same:
57 see `Rules to contribute`_ for more information.
59 In general it's best to provide git-formatted patches made from the
60 current Git (see `Committing`_)::
62     $ git commit -a
63     $ git format-patch HEAD^
65 We also accept patches against other releases, but it's more work for us.
67 If you're not using Git, although you're strongly suggested to use it,
68 you can use the diff command::
70     $ diff -u originalpath modifiedpath > new-feature.patch
72 However, such a patch won't contain the authoring information nor the
73 patch's description.
75 .. note::
76     Please make sure patches follow the style of existing code - In
77     particular, use tabs for indentation. See `Coding`_.
79 Rules to contribute
80 -------------------
82 Keep in mind this is best to check with us by email on mailing list
83 whether a new feature is appropriate and whether someone is already
84 working on similar code.
86 Please, make sure contributions you make follow these rules:
88 * changes should be made in a dedicated branch for pull requests.
89 * only one feature should be in each pull request (or patch).
90 * pull requests (or patches) should not contain changes unrelated to the feature,
91   and commits should be sensible units of change.
92 * the submitter should squash together corrections that are part of
93   the development process, especially correcting your own mistakes.
94 * Please make sure your modifications follow the style of existing code:
95   see `Coding`_ for more information.
97 See `Committing`_ for more information.
99 Windows tools
100 -------------
101 * Git: http://git-scm.com/ and http://msysgit.github.io/
102 * diff, grep, etc: http://mingw.org/ or http://unxutils.sourceforge.net/
104 See also the 'Building on Windows' document on the website.
106 File organization
107 -----------------
108 callbacks.c is just for Glade callbacks.
109 Avoid adding code to geany.h if it will fit better elsewhere.
110 See the top of each ``src/*.c`` file for a brief description of what
111 it's for.
113 Plugin API code
114 ---------------
115 Please be aware that anything with a doc-comment (a comment with an
116 extra asterix: ``/**``) is something in the plugin API. Things like
117 enums and structs can usually still be appended to, ensuring that all
118 the existing elements stay in place - this will keep the ABI stable.
120 .. warning::
122     Some structs like GeanyCallback cannot be appended to without
123     breaking the ABI because they are used to declare structs by
124     plugins, not just for accessing struct members through a pointer.
125     Normally structs should never be allocated by plugins.
127 Keeping the plugin ABI stable
128 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
129 Before the 1.0 release series, the ABI can change when necessary, and
130 even the API can change. An ABI change just means that all plugins will
131 not load and they must be rebuilt. An API change means that some plugins
132 might not build correctly.
134 If you're reordering or changing existing elements of structs that are
135 used as part of the plugin API, you must increment GEANY_ABI_VERSION
136 in plugindata.h. This is usually not needed if you're just appending
137 fields to structs. The GEANY_API_VERSION value should be incremented
138 for any changes to the plugin API, including appending elements.
140 If you're in any doubt when making changes to plugin API code, just ask us.
142 Plugin API/ABI design
143 ^^^^^^^^^^^^^^^^^^^^^
144 You should not make plugins rely on the size of a struct. This means:
146 * Don't let plugins allocate any structs (stack or heap).
147 * Don't let plugins index any arrays of structs.
148 * Don't add any array fields to structs in case we want to change the
149   array size later.
151 Doc-comments
152 ^^^^^^^^^^^^
153 * The @file tag can go in the source .c file, but use the .h header name so
154   it appears normally in the generated documentation. See ui_utils.c for an
155   example.
156 * Function doc-comments should always go in the source file, not the
157   header, so they can be updated if/when the implementation changes.
159 Glade
160 -----
161 Add user-interface widgets to the Glade 3 file ``data/geany.glade``.
162 Callbacks for the user-interface should go in ``src/callbacks.c``.
164 Use Glade 3.8.5. The 3.8 series still supports GTK+ 2, and earlier
165 point releases did not preserve the order of XML elements, leading to
166 unmanageable diffs.
168 GTK versions & API documentation
169 --------------------------------
170 Geany requires GTK >= 2.24 and GLib >= 2.28. API symbols from newer
171 GTK/GLib versions should be avoided or made optional to keep the source
172 code building on older systems.
174 It is recommended to use the 2.24 API documentation of the GTK 
175 libs (including GLib, GDK and Pango) has the advantages 
176 that you don't get confused by any newer API additions and you 
177 don't have to take care about whether you can use them or not.
179 Coding
180 ------
181 * Don't write long functions with a lot of variables and/or scopes - break
182   them down into smaller static functions where possible. This makes code
183   much easier to read and maintain.
184 * Use GLib types and functions - gint not int, g_free() not free().
185 * Your code should build against GLib 2.27.3 and GTK 2.24. At least for the
186   moment, we want to keep the minimum requirement for GTK at 2.24 (of
187   course, you can use the GTK_CHECK_VERSION macro to protect code using
188   later versions).
189 * Variables should be declared before statements. You can use
190   gcc's -Wdeclaration-after-statement to warn about this.
191 * Don't let variable names shadow outer variables - use gcc's -Wshadow
192   option.
193 * Do not use G_LIKELY or G_UNLIKELY (except in critical loops). These
194   add noise to the code with little real benefit.
196 Compiler options & warnings
197 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
198 Use ``CFLAGS='-Wfoo' ./configure`` or ``CFLAGS='-Wfoo' ./autogen.sh``
199 to set warning options (as well as anything else e.g. -g -O2).
201 * Enable warnings - for gcc use '-Wall -W' (and optionally
202   -Wno-unused-parameter to avoid unused parameter warnings in Glade
203   callbacks).
204 * You should try to write ISO C99 code for portability, so always
205   use C ``/* */`` comments and function_name(void) instead of
206   function_name(). This is for compatibility with various Unix-like
207   compilers. You should use -std=c99 to help check this.
209 .. tip::
210     Remember for gcc you need to enable optimization to get certain
211     warnings like uninitialized variables, but for debugging it's
212     better to have no optimization on.
214 Style
215 ^^^^^
216 * We use a tab width of 4 and indent completely with tabs not spaces.
217   Note the documentation files use (4) spaces instead, so you may want
218   to use the 'Detect from file' indent pref.
219 * Do not add whitespace at the end of lines, this adds to commit noise.
220   When editing with Geany set preference files->Strip trailing spaces
221   and tabs.
222 * Use the multiline comment ``/* */`` to comment small blocks of code,
223   functions descriptions or longer explanations of code, etc. The more
224   comments are in your code the better. (See also
225   ``scripts/fix-cxx-comments.pl`` in Git).
226 * Lines should not be longer than about 100 characters and after 100
227   characters the lines should be wrapped and indented once more to
228   show that the line is continued.
229 * We don't put spaces between function names and the opening brace for
230   argument lists.
231 * Variable declarations come first after an opening brace, then one
232   newline to separate declarations and code.
233 * 2-operand operators should have a space each side.
234 * Function bodies should have 2 blank newlines after them.
235 * Align braces together on separate lines.
236 * Don't put assignments in 'if/while/etc' expressions except for loops,
237   for example ``for (int i = 0; i < some_limit; i++)``.
238 * if statements without brace bodies should have the code on a separate
239   line, then a blank line afterwards.
240 * Use braces after if/while statements if the body uses another
241   if/while statement.
242 * Try to fit in with the existing code style.
244 .. note::
245     A few of the above can be done with the Git
246     ``scripts/fix-alignment.pl``, but it is quite dumb and it's much better
247     to write it correctly in the first place.
248     ``scripts/rstrip-whitespace.py`` just removes trailing whitespace.
251 .. below tabs should be used, but spaces are required for reST.
253 Example::
255     struct Bar;
257     typedef struct Foo  /* struct names normally are the same as typedef names */
258     {
259         gint    foo;    /* names are somewhat aligned visually */
260         gint    bar;    /* fields don't share the same line */
261         SomeLongTypeName baz; /* alignment is not strict */
262         gchar   *ptr;   /* pointer symbol must go next to variable name, not type */
263         Bar     public; /**< only plugin API fields have a doc-comment */
264     }
265     Foo;
268     gint some_func(void);
270     gint some_other_func(void);
273     /* optional function comment explains something important */
274     gint function_long_name(gchar arg1, <too many args to fit on this line>,
275             gchar argN)
276     {
277         /* variable declarations always go before code in each scope */
278         /* variable names should NOT be aligned at all */
279         gint foo, bar;  /* variables can go on the same line */
280         gint baz;       /* but often don't */
281         gchar *ptr;     /* pointer symbol must go next to variable name, not type */
282         gchar *another; /* pointers should normally go on separate lines */
284         /* Some long comment block
285          * taking several different
286          * lines to explain */
287         if (foo)
288         {
289             /* variables only used in one scope should normally be declared there */
290             gint dir = -1;
292             bar = foo;
293             if ((bar & (guint)dir) != 7)
294                 some_code(arg1, <too many args to fit on this line>,
295                     argN - 1, argN);
297             some_func();
298         }
299     }
302     /** Explains using doc-comments for plugin API functions.
303      * First line should be short and use the third person tense - 'explains',
304      * not 'explain'.
305      *
306      * @return Some number.
307      * @since 1.22. */
308     gint another_function(void)
309     {
310         ...
312 Header Includes
313 ---------------
315 In order to make including various headers in Geany more convenient, each
316 file should include what it uses. If there is a file named ``foo.c``, and a
317 file named ``foo.h``, it should be possible to include ``foo.h`` on its own
318 without depending on stuff in ``foo.c`` that is included for the first time
319 before ``foo.h``.
321 Private Headers
322 ^^^^^^^^^^^^^^^
324 If there is some data that needs to be shared between various parts of the
325 core code, put them in a "private header", that is, if the public header is
326 called ``foo.h``, then make a ``fooprivate.h`` header that contains the
327 non-public functions, types, globals, etc that are needed. Other core source
328 files can then just include the ``foo.h`` and/or ``fooprivate.h`` depending
329 what they need, without exposing that stuff to plugins.
331 Order of Includes
332 ^^^^^^^^^^^^^^^^^
334 Inside a source file the includes section should be ordered like this:
336 1. Always include the ``config.h`` file at the start of every source file,
337    for example::
339     #ifdef HAVE_CONFIG_H
340     # include "config.h"
341     #endif
343    This allows the Autotools and other build systems use the ``./configure``
344    time settings. If you don't do this, there's likely to be a number of
345    macros that you'll have to define in the build system or custom headers.
347    Warning: Never include ``config.h`` in headers, and especially in "public"
348    headers that plugins might include.
350 2. Then include the header that has the same name as the source file (if
351    applicable). For example, for a source file named ``foo.c``, include
352    the ``foo.h`` below the ``config.h`` include. If there is a
353    ``fooprivate.h``, ``foo.c`` will most likely want to include that too,
354    put it in with includes in #3.
356 3. At this point, it should be safe to include all the headers that declare
357    whatever is needed. If everything generally "includes what it uses" and
358    all files included contain the appropriate multiple-declaration guards
359    then the order of includes is fairly arbitrary. Prefer to use English
360    alphabetic order if possible.
362 4. By now it doesn't really matter about the order, nothing below here is
363    "our problem". Semi-arbitrarily, you should use an include order like this:
365     1. Standard C headers
366     2. Non-standard system headers (eg. ``windows.h`` or ``unistd.h``)
367     3. GLib/GTK+ or related headers
369 5. Everything else that should not influence 1-4.
371 Including in Header Files
372 ^^^^^^^^^^^^^^^^^^^^^^^^^
374 Headers should also include what they use. All of the types should defined in
375 order to allow the header to be included stand-alone. For example, if a
376 header uses a ``GtkWidget*``, it should ``#include <gtk/gtk.h>``. Or, if a
377 headers uses a ``GPtrArray*``, it should ``#include <glib.h>`` to ensure that
378 all of the types are declared, whether by pointers/opaquely or fully, as
379 required. Since all headers will use a ``G_BEGIN_DECLS`` and ``G_END_DECLS``
380 guard for C++, the bare minimum for a header is to include ``glib.h`` or
381 ``<gtk/gtk.h>`` or ``gtkcompat.h`` or some other header that makes those
382 macros available.
385 Committing
386 ----------
388 * Commit one thing at a time, do small commits.  Commits should be
389   meaningful and not too big when possible; multiple small commits are
390   good if there is no good reason to group them.
391 * Use meaningful name and email in the Author and Committer fields.
392   This helps knowing who did what and allows to contact the author if
393   there is a good reason to do so (unlikely, but can happen).
394 * When working on a new feature, create a new branch for it.  When
395   merging it, use the --no-ff option to make sure a merge commit will
396   be created to better track what happened.  However, if the feature
397   only took one commit you might merge it fast-forward since there is
398   not history to keep together.
400 Commit messages
401 ^^^^^^^^^^^^^^^
402 Follow the standard Git formatting:
404 * No line should use more than about 80 characters (around 72 is best).
405 * The first line is the commit's summary and is followed by an empty
406   line.  This summary should be one line and one line only, thus less
407   than 80 characters.  This summary should not include any punctuation
408   unless really needed.  See it as the subject of an email: keep it
409   concise and as precise as you can, but not tool long.
410 * Following lines are optional detailed commit information, with
411   paragraphs separated by blank lines.  This part should be as long as
412   needed to describe the commit in depth, should use proper
413   punctuation and should include any useful information, like the
414   motivation for the patch and/or any valuable details the diff itself
415   don't provide or don't make clear.  Make it as complete as you think
416   it makes sense, but don't include an information that is better
417   explained by the commit's diff.
419   It is OK to use ASCII formatting like bullet list using "*" or "-",
420   etc. if useful, but emphasis (bold, italic, underline) should be
421   avoided.
423 Example::
425     Ask the user if spawn fails in utils_open_browser()
427     Ask the user to configure a valid browser command if spawning it
428     fails rather than falling back to some arbitrary hardcoded defaults.
430     This avoid spawning an unexpected browser when the configured one is
431     wrong, and gives the user a chance to correctly fix the preference.
434 Testing
435 -------
436 * Run with ``-v`` to print any debug messages.
437 * You can use a second instance (``geany -i``).
438 * To check first-run behaviour, use an alternate config directory by
439   passing ``-c some_dir`` (but make sure the directory is clean first).
440 * For debugging tips, see `GDB`_.
442 Bugs to watch out for
443 ---------------------
444 * Forgetting to check *doc->is_valid* when looping through
445   *documents_array* - instead use *foreach_document()*.
446 * Inserting fields into structs in the plugin API instead of appending.
447 * Not breaking the plugin ABI when necessary.
448 * Using an idle callback that doesn't check main_status.quitting.
449 * Forgetting to call vStringTerminate in CTags code.
450 * Forgetting CRLF line endings on Windows.
451 * Not handling Tabs & Spaces indent mode.
453 Libraries
454 ---------
455 We try to use an unmodified version of Scintilla - any new lexers or
456 other changes should be passed on to the maintainers at
457 http://scintilla.org. We normally update to a new Scintilla release
458 shortly after one is made. See also scintilla/README.
460 Tagmanager was originally taken from Anjuta 1.2.2, and parts of it
461 (notably c.c) have been merged from later versions of Anjuta and
462 CTags. The independent Tagmanager library itself ceased development
463 before Geany was started. It's source code parsing is mostly taken from
464 Exuberant CTags (see http://ctags.sf.net). If appropriate it's good to
465 pass language parser changes back to the CTags project.
468 Notes
469 =====
470 Some of these notes below are brief (or maybe incomplete) - please
471 contact the geany-devel mailing list for more information.
473 Using pre-defined autotools values
474 ----------------------------------
475 When you are use macros supplied by the autotools like GEANY_PREFIX,
476 GEANY_LIBDIR, GEANY_DATADIR and GEANY_LOCALEDIR be aware that these
477 might not be static strings when Geany is configured with
478 --enable-binreloc. Then these macros will be replaced by function calls
479 (in src/prefix.h). So, don't use anything like
480 printf("Prefix: " GEANY_PREFIX); but instead use
481 printf("Prefix: %s", GEANY_PREFIX);
483 Adding a source file foo.[hc] in src/ or plugins/
484 -------------------------------------------------
485 * Add foo.c, foo.h to SRCS in path/Makefile.am.
486 * Add foo.o to OBJS in path/makefile.win32.
487 * Add path/foo.c to geany_sources in wscript.
488 * Add path/foo.c to po/POTFILES.in (for string translation).
490 Adding a filetype
491 -----------------
492 You can add a filetype without syntax highlighting or tag parsing, but
493 check to see if those features have been written in upstream projects
494 first (scintilla or ctags).
496 **Custom:**
498 If you want to reuse an existing lexer and/or tag parser, making a
499 custom filetype is probably easier - it doesn't require any
500 changes to the source code. Follow instructions in the manual:
501 http://geany.org/manual/index.html#custom-filetypes. Don't forget to
502 update the ``[Groups]`` section in ``filetype_extensions.conf``.
504 .. warning::
505   You should use the newer `[build-menu]` section for default build
506   commands - the older `[build_settings]` may not work correctly for
507   custom filetypes.
509 **Built-in:**
511 * Add GEANY_FILETYPES_FOO to filetypes.h.
512 * Initialize GEANY_FILETYPES_FOO in init_builtin_filetypes() of
513   filetypes.c.
514 * Update data/filetype_extensions.conf.
516 The remaining notes relate mostly to built-in filetypes.
518 filetypes.* configuration file
519 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
520 All languages need a data/filetypes.foo configuration file. See
521 the "Filetype definition files" section in the manual and/or
522 data/filetypes.c for an example.
524 Programming languages should have:
526 * [keywords] if the lexer supports it.
527 * [settings] mostly for comment settings.
528 * [build-menu] (or [build_settings]) for commands to run.
530 For languages with a Scintilla lexer, there should be a [styling] section,
531 to correspond to the styles used in highlighting_styles_FOO[] in
532 highlightingmappings.h - see below.
534 Don't forget to add the newly created filetype file to data/Makefile.am.
536 Syntax highlighting
537 ^^^^^^^^^^^^^^^^^^^
538 It may be possible to use an existing Scintilla lexer in the scintilla/
539 subdirectory - if not, you will need to find (or write) one,
540 LexFoo.cxx. Try the official Scintilla project first.
542 .. warning::
543     We won't accept adding a lexer that conflicts with one in
544     Scintilla. All new lexers should be submitted back to the Scintilla
545     project to save duplication of work.
547 When adding a lexer, update:
549 * scintilla/Makefile.am
550 * scintilla/makefile.win32
551 * wscript
552 * scintilla/src/Catalogue.cxx - add a LINK_LEXER command *manually*
554 For syntax highlighting, you will need to edit highlighting.c and
555 highlightingmappings.h and add the following things:
557 1. In highlightingmappings.h:
559    a. define ``highlighting_lexer_FOO`` to the Scintilla lexer ID for
560       this filtype, e.g. ``SCLEX_CPP``.
561    b. define the ``highlighting_styles_FOO`` array that maps Scintilla
562       style states to style names in the configuration file.
563    c. define ``highlighting_keywords_FOO`` to ``EMPTY_KEYWORDS`` if the
564       filtype has no keywords, or as an ``HLKeyword`` array mapping
565       the Scintilla keyword IDs to names in the configuration file.
566    d. define ``highlighting_properties_FOO`` to ``EMPTY_PROPERTIES``, or
567       as an array of ``HLProperty`` if the filetype requires some lexer
568       properties to be set.  However, note that properties should
569       normally be set in the ``[lexer_properties]`` section of the
570       configuration file instead.
572    You may look at other filtype's definitions for some examples
573    (Ada, CSS or Diff being good examples).
575 2. In highlighting.c:
577    a. Add ``init_styleset_case(FOO);`` in ``highlighting_init_styles()``.
578    b. Add ``styleset_case(FOO);`` in ``highlighting_set_styles()``.
580 3. Write data/filetypes.foo configuration file [styling] section. See
581    the manual and see data/filetypes.d for a named style example.
583 .. note::
584     Please try to make your styles fit in with the other filetypes'
585     default colors, and to use named styles where possible (e.g.
586     "commentline=comment"). Filetypes that share a lexer should have
587     the same colors. If not using named styles, leave the background color
588     empty to match the default color.
590 Error message parsing
591 ^^^^^^^^^^^^^^^^^^^^^
592 New-style error message parsing is done with an extended GNU-style regex
593 stored in the filetypes.foo file - see the [build_settings] information
594 in the manual for details.
596 Old-style error message parsing is done in
597 msgwin_parse_compiler_error_line() of msgwindow.c - see the ParseData
598 typedef for more information.
600 Other features
601 ^^^^^^^^^^^^^^
602 If the lexer has comment styles, you should add them in
603 highlighting_is_comment_style(). You should also update
604 highlighting_is_string_style() for string/character styles. For now,
605 this prevents calltips and autocompletion when typing in a comment
606 (but it can still be forced by the user).
608 For brace indentation, update lexer_has_braces() in editor.c;
609 indentation after ':' is done from on_new_line_added().
611 If the Scintilla lexer supports user type keyword highlighting (e.g.
612 SCLEX_CPP), update document_update_tags() in document.c.
614 Adding a TagManager parser
615 ^^^^^^^^^^^^^^^^^^^^^^^^^^
616 This assumes the filetype for Geany already exists.
618 First write or find a CTags compatible parser, foo.c. Check this fork:
619 https://github.com/fishman/ctags
621 There may be some unmerged language patches for CTags at:
622 http://sf.net/projects/ctags - see the tracker.
624 (You can also try the Anjuta project's anjuta-tags codebase.)
626 .. note::
627     From Geany 1.22 GLib's GRegex engine is used instead of POSIX
628     regex, unlike CTags. It should be close enough to POSIX to work
629     OK.
630     We no longer support regex parsers with the "b" regex flag
631     option set and Geany will print debug warnings if it's used.
632     CTags supports it but doesn't currently (2011) include any
633     parsers that use it. It should be easy to convert to extended
634     regex syntax anyway.
636 Method
637 ``````
638 * Add foo.c to SRCS in Makefile.am.
639 * Add foo.o to OBJS in makefile.win32.
640 * Add path/foo.c to geany_sources in wscript.
641 * Add Foo to parsers.h
642 * Add TM_PARSER_FOO to tagmanager/src/tm_parser.h.  The list here must follow
643   exactly the order in parsers.h.
645 In foo.c:
646 Edit FooKinds 3rd column to match a s_tag_type_names string in tm_tag.c.
647 (You may want to make the symbols.c change before doing this).
649 In filetypes.c, init_builtin_filetypes():
650 Set the 2nd argument of the FT_INIT() macro for this filetype to FOO.
652 In symbols.c:
653 Unless your parser uses C-like tag type kinds, update
654 add_top_level_items() for foo, calling tag_list_add_groups(). See
655 get_tag_type_iter() for which tv_iters fields to use.
657 Tests
658 `````
659 The tag parser tests checks if the proper tags are emitted
660 for a given source. Tests for tag parsers consist of two files: the
661 source to parse, and the expected output. Tests are run using ``make
662 check``.
664 The source to parse should be in the file ``tests/ctags/mytest.ext``,
665 where ``mytest`` is the name you choose for your test, and ``ext`` is an
666 extension recognized by Geany as the language the test file is for.
667 This file should contain a snippet of the language to test for.
668 It can be either long or short, depending on what it tests.
670 The expected output should be in the file ``tests/ctags/mytest.ext.tags``
671 (which is the same name as the source, but with ``.tags`` appended), and
672 should be in the format generated by ``geany -g``. This file contains
673 the tag information expected to be generated from the corresponding
674 source file.
676 When you have these two files, you have to list your new test along the
677 other ones in the ``test_source`` variable in ``tests/ctags/Makefile.am``.
678 Please keep this list sorted alphabetically.
680 Upgrading Scintilla
681 -------------------
683 To upgrade the local Scintilla copy, use the ``scripts/update-scintilla.sh``
684 script.
686 To use it, you need to first obtain a copy of the Scintilla sources you want
687 to update to.  This will generally mean checking out a release tag from the
688 Scintilla Mercurial repository, or extracting a tarball.
690 Then, just run the script from Geany's to source directory passing the path
691 to the Scintilla source directory as first argument, and follow the
692 instructions, if any::
694     ./scripts/update-scintilla.sh /path/to/scintilla/
699 Stop on warnings
700 ^^^^^^^^^^^^^^^^
701 When a GLib or GTK warning is printed, often you want to get a
702 backtrace to find out what code caused them. You can do that with the
703 ``--g-fatal-warnings`` argument, which will abort Geany on the first
704 warning it receives.
706 But for ordinary testing, you don't always want your editor to abort
707 just because of a warning - use::
709     (gdb) b handler_log if level <= G_LOG_LEVEL_WARNING
712 Running with batch commands
713 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
714 Use::
716     $ gdb src/geany -x gdb-commands
718 Where ``gdb-commands`` is a file with the following lines::
720     set pagination off
721     b handler_log if level <= G_LOG_LEVEL_WARNING
722     r -v
725 Loading a plugin
726 ^^^^^^^^^^^^^^^^
727 This is useful so you can load plugins without installing them first.
728 Alternatively you can use a symlink in ~/.config/geany/plugins or
729 $prefix/lib/geany (where $prefix is /usr/local by default).
731 The gdb session below was run from the toplevel Geany source directory.
732 Start normally with e.g. "gdb src/geany".
733 Type 'r' to run.
734 Press Ctrl-C from the gdb window to interrupt program execution.
736 Example::
738     Program received signal SIGINT, Interrupt.
739     0x00d16402 in __kernel_vsyscall ()
740     (gdb) call plugin_new("./plugins/.libs/demoplugin.so")
741     ** INFO: Loaded:   ./plugins/.libs/demoplugin.so (Demo)
742     $1 = (Plugin *) 0x905a890
743     (gdb) c
744     Continuing.
746     Program received signal SIGINT, Interrupt.
747     0x00d16402 in __kernel_vsyscall ()
748     (gdb) call plugin_free(0x905a890)
749     ** INFO: Unloaded: ./plugins/.libs/demoplugin.so
750     (gdb) c
751     Continuing.
753 Building Plugins
754 ^^^^^^^^^^^^^^^^
756 The geany-plugins autotools script automatically detects the
757 installed system Geany and builds the plugins against that.
759 To use plugins with a development version of Geany built with
760 a different prefix, the plugins will need to be compiled against
761 that version if the ABI has changed.
763 To do this you need to specify both --prefix and --with-geany-libdir
764 to the plugin configure.  Normally the plugin prefix is the
765 same as the Geany prefix to keep plugins with the version of Geany
766 that they are compiled against, and with-geany-libdir is the Geany
767 prefix/lib.
769 Whilst it is possible for the plugin prefix to be different to
770 the prefix of the libdir (which is why there are two settings),
771 it is probably better to keep the version of Geany and its plugins
772 together.