summary refs log tree commit diff stats
path: root/share/doc/hacking.md
blob: 68badd719aa91817691a2dae855e3c1a1e3b0239 (plain) (blame)
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
# HexChat Hacking Guidelines

Just some tips if you're going to help with HexChat code (patches etc):

* Use tabs, not spaces, to indent code.

* Use a tab size of 3 (most editors will let you choose this).
  Type :set ts=3 in vim/gvim.

* Try to stick to the same consistant coding style (vertically aligned braces, a space after if, while, functions etc.):

	<pre>void
	routine (void)
	{
		if (function (a, b, c))
		{
			x = a + 1;
		}
	}</pre>

* Don't use "//" C++ style comments, some compilers don't like them.

* When opening a file with Unix level functions (open, read/write, close)
  as opposed to the C level functions (fopen, fwrite/fread, fclose), use
  the OFLAGS macro. This makes sure it'll work on Win32 aswell as Unix e.g.:

	<pre>fh = open ("file", OFLAGS | O_RDONLY);</pre>

* Use closesocket() for sockets, and close() for normal files.

* Don't read() from sockets, use recv() instead.

* Please provide unified format diffs (run diff -u).

* Call your patch something more meaningfull than hexchat.diff.

* To make a really nice and clean patch, do something like this:

	* Have two directories, unpacked from the original archive:

		<pre>hexchat-2.9.0/
		hexchat-2.9.0p1/</pre>

	* Then edit/compile the hexchat-2.9.0p1 directory. To create a patch:

		* Windows:

			<pre>rmdir /q /s hexchat-2.9.0p1/win32/build
			rmdir /q /s hexchat-2.9.0p1/win32/build-xp
			diff -ruN --strip-trailing-cr hexchat-2.9.0 hexchat-2.9.0p1 > hexchat-something.diff
			</pre>

		* Unix:

			<pre>diff -ruN hexchat-2.9.0 hexchat-2.9.0p1 > hexchat-something.diff</pre>
ground-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
<?xml version="1.0" encoding="UTF-8" ?>

<node name="/">

  <interface name="org.xchat.connection">
    <method name="Connect">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg type="s" name="filename" direction="in"/>
      <arg type="s" name="name" direction="in"/>
      <arg type="s" name="desc" direction="in"/>
      <arg type="s" name="version" direction="in"/>
      <arg type="s" name="path" direction="out"/>
    </method>  
    <method name="Disconnect">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
    </method>
  </interface>

  <interface name="org.xchat.plugin">
    <method name="Command">
      <arg type="s" name="command" direction="in"/>
    </method>
    <method name="Print">
      <arg type="s" name="text" direction="in"/>
    </method>
    <method name="FindContext">
      <arg type="s" name="server" direction="in"/>
      <arg type="s" name="channel" direction="in"/>
      <arg type="u" name="ret_id" direction="out"/>
    </method>
    <method name="GetContext">
      <arg type="u" name="ret_id" direction="out"/>
    </method>
    <method name="SetContext">
      <arg type="u" name="id" direction="in"/>
      <arg type="b" name="ret" direction="out"/>
    </method>
    <method name="GetInfo">
      <arg type="s" name="id" direction="in"/>
      <arg type="s" name="ret_info" direction="out"/>
    </method>
    <method name="GetPrefs">
      <arg type="s" name="name" direction="in"/>
      <arg type="i" name="ret_type" direction="out"/>
      <arg type="s" name="ret_str" direction="out"/>
      <arg type="i" name="ret_int" direction="out"/>
    </method>
    <method name="HookCommand">
      <arg type="s" name="name" direction="in"/>
      <arg type="i" name="priority" direction="in"/>
      <arg type="s" name="help_text" direction="in"/>
      <arg type="i" name="return_value" direction="in"/>
      <arg type="u" name="ret_id" direction="out"/>
    </method>
    <method name="HookServer">
      <arg type="s" name="name" direction="in"/>
      <arg type="i" name="priority" direction="in"/>
      <arg type="i" name="return_value" direction="in"/>
      <arg type="u" name="ret_id" direction="out"/>
    </method>
    <method name="HookPrint">
      <arg type="s" name="name" direction="in"/>
      <arg type="i" name="priority" direction="in"/>
      <arg type="i" name="return_value" direction="in"/>
      <arg type="u" name="ret_id" direction="out"/>
    </method>
    <method name="Unhook">
      <arg type="u" name="id" direction="in"/>
    </method>
    <method name="ListGet">
      <arg type="s" name="name" direction="in"/>
      <arg type="u" name="ret_id" direction="out"/>
    </method>
    <method name="ListNext">
      <arg type="u" name="id" direction="in"/>
      <arg type="b" name="ret" direction="out"/>
    </method>
    <method name="ListStr">
      <arg type="u" name="id" direction="in"/>
      <arg type="s" name="name" direction="in"/>
      <arg type="s" name="ret_str" direction="out"/>
    </method>
    <method name="ListInt">
      <arg type="u" name="id" direction="in"/>
      <arg type="s" name="name" direction="in"/>
      <arg type="i" name="ret_int" direction="out"/>
    </method>
    <method name="ListTime">
      <arg type="u" name="id" direction="in"/>
      <arg type="s" name="name" direction="in"/>
      <arg type="t" name="ret_time" direction="out"/>
    </method>
    <method name="ListFields">
      <arg type="s" name="name" direction="in"/>
      <arg type="as" name="ret" direction="out"/>
    </method>
    <method name="ListFree">
      <arg type="u" name="id" direction="in"/>
    </method>
    <method name="EmitPrint">
      <arg type="s" name="event_name" direction="in"/>
      <arg type="as" name="args" direction="in"/>
      <arg type="b" name="ret" direction="out"/>
    </method>
    <method name="Nickcmp">
      <arg type="s" name="nick1" direction="in"/>
      <arg type="s" name="nick2" direction="in"/>
      <arg type="i" name="ret" direction="out"/>
    </method>
    <method name="Strip">
      <arg type="s" name="str" direction="in"/>
      <arg type="i" name="len" direction="in"/>
      <arg type="i" name="flag" direction="in"/>
      <arg type="s" name="ret_str" direction="out"/>
    </method>
    <method name="SendModes">
      <arg type="as" name="targets" direction="in"/>
      <arg type="i" name="modes_per_line" direction="in"/>
      <arg type="y" name="sign" direction="in"/>
      <arg type="y" name="mode" direction="in"/>
    </method>

    <signal name="CommandSignal">
      <arg type="as" name="word"/>
      <arg type="as" name="word_eol"/>
      <arg type="u" name="hook_id"/>
      <arg type="u" name="context_id"/>
    </signal>
    <signal name="ServerSignal">
      <arg type="as" name="word"/>
      <arg type="as" name="word_eol"/>
      <arg type="u" name="hook_id"/>
      <arg type="u" name="context_id"/>
    </signal>
    <signal name="PrintSignal">
      <arg type="as" name="word"/>
      <arg type="u" name="hook_id"/>
      <arg type="u" name="context_id"/>
    </signal>
    <signal name="UnloadSignal"/>
  </interface>
</node>