Coding Style - Revision history

Mgmax: /* Editor support */ remove discussion section -- is already in the coding style guide

2018-09-15T17:59:53Z

Editor support: remove discussion section -- is already in the coding style guide

← Older revision		Revision as of 17:59, 15 September 2018
Line 5:		Line 5:
	This page is for discussing and working out changes and improvements to that document. When concensus		This page is for discussing and working out changes and improvements to that document. When concensus
	is reached, the document can be updated in SVN in the inkscape_web module.		is reached, the document can be updated in SVN in the inkscape_web module.

	~~=== Editor support ===~~

	~~Place the following at the end of source files to help emacsen & vim users follow some of our guidelines automatically:~~
	~~<pre>~~
	/*
	~~Local Variables:~~
	~~mode:c++~~
	~~c-file-style:"stroustrup"~~
	~~c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))~~
	~~indent-tabs-mode:nil~~
	~~fill-column:99~~
	~~End:~~
	*/
	~~// vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :~~
	~~</pre>~~

	~~Once you've added those lines, close the file and re-open it for it to take effect.~~

	~~Then (for emacsen users), one can re-indent a region with C-M-\.~~

	=== camelCase v. Underscores ===		=== camelCase v. Underscores ===

~suv: /* Inkscape Coding Style Discussion */ update outdated link

2016-05-21T17:02:49Z

Inkscape Coding Style Discussion: update outdated link

← Older revision		Revision as of 17:02, 21 May 2016
Line 1:		Line 1:
	== Inkscape Coding Style Discussion ==		== Inkscape Coding Style Discussion ==

	The official code style documentation is on the main website.		The official code style documentation is on the main website: [https://inkscape.org/develop/coding-style/ Inkscape Coding Style]
	~~"http~~://~~www.~~inkscape.org/~~doc~~/~~coding_style.php"~~

	This page is for discussing and working out changes and improvements to that document. When concensus		This page is for discussing and working out changes and improvements to that document. When concensus

Romain2Boss: Link fixed

2012-12-28T20:16:23Z

Link fixed

← Older revision		Revision as of 20:16, 28 December 2012
Line 50:		Line 50:
	=== Underscore as first character of identifiers ===		=== Underscore as first character of identifiers ===
	* Please consider that the C++ standard reserves _* identifiers [17.4.3.1.2]: "Each name that begins with an underscore is reserved to the implementation for use as a name in the global namespace".		* Please consider that the C++ standard reserves _* identifiers [17.4.3.1.2]: "Each name that begins with an underscore is reserved to the implementation for use as a name in the global namespace".
	* You can use a ~~<b>~~leading underscore for class members~~</b>~~ (variables of a class), to clearly mark them as a class member. This may prevent bugs: for example a temporary variable called 'curve' would hide an SPShape's '_curve' member if it did not have that leading underscore.		* You can use a '''leading underscore for class members''' (variables of a class), to clearly mark them as a class member. This may prevent bugs: for example a temporary variable called 'curve' would hide an SPShape's '_curve' member if it did not have that leading underscore.

	=== Tabs and Alignment ===		=== Tabs and Alignment ===
Line 226:		Line 226:
	*** A special [non-] case of this is needing a member function declaration. Member function declarations can't be separated from their class definition. See also `methods vs functions' above.		*** A special [non-] case of this is needing a member function declaration. Member function declarations can't be separated from their class definition. See also `methods vs functions' above.
	** Suppose that struct Foo has a `Bar _bar' member. The translation unit may need to create Foo objects (and thus need the type definition of Bar to know its size), but not need to access _bar (so not needing anything from bar.h other than the type definition of Bar).		** Suppose that struct Foo has a `Bar _bar' member. The translation unit may need to create Foo objects (and thus need the type definition of Bar to know its size), but not need to access _bar (so not needing anything from bar.h other than the type definition of Bar).
	*** This is very common. Common examples of Bar: SPShape, NR::Point[[/NR]]::Matrix.		*** This is very common. Common examples of Bar: SPShape, NR::Point/NR::Matrix.
	** Needs some function declarations but not others.		** Needs some function declarations but not others.
	** Needs some type forward declarations but not others.		** Needs some type forward declarations but not others.

Romain2Boss: /* Widgets */ Copy&Paste error

2012-03-18T23:12:10Z

Widgets: Copy&Paste error

← Older revision		Revision as of 23:12, 18 March 2012
Line 278:		Line 278:
	=== Widgets ===		=== Widgets ===

	* ~~Dialogs~~ source codes have to be localized in src/ui/widget/		* Widget source codes have to be localized in src/ui/widget/
	* A widget belongs to the namespace Inkscape::UI::Widget		* A widget belongs to the namespace Inkscape::UI::Widget

	[[Category:Developer Discussion]]		[[Category:Developer Discussion]]

Johanengelen: /* Underscore as first character of identifiers */

2012-01-17T22:39:29Z

Underscore as first character of identifiers

← Older revision		Revision as of 22:39, 17 January 2012
Line 50:		Line 50:
	=== Underscore as first character of identifiers ===		=== Underscore as first character of identifiers ===
	* Please consider that the C++ standard reserves _* identifiers [17.4.3.1.2]: "Each name that begins with an underscore is reserved to the implementation for use as a name in the global namespace".		* Please consider that the C++ standard reserves _* identifiers [17.4.3.1.2]: "Each name that begins with an underscore is reserved to the implementation for use as a name in the global namespace".
			* You can use a <b>leading underscore for class members</b> (variables of a class), to clearly mark them as a class member. This may prevent bugs: for example a temporary variable called 'curve' would hide an SPShape's '_curve' member if it did not have that leading underscore.

	=== Tabs and Alignment ===		=== Tabs and Alignment ===

Kris: /* Tabs and Alignment */ wikify ;-)

2012-01-17T21:39:11Z

Tabs and Alignment: wikify ;-)

← Older revision		Revision as of 21:39, 17 January 2012
Line 53:		Line 53:
	=== Tabs and Alignment ===		=== Tabs and Alignment ===

	Inkscape code uses 4 spaces for indentation and ~~<b>~~no tabs anywhere~~</b>~~.		Inkscape code uses 4 spaces for indentation and '''no tabs anywhere'''.

	That's clear (not to mention sensible). However, on the mail Coding Style page it says this:		That's clear (not to mention sensible). However, on the mail Coding Style page it says this:

Johanengelen: /* Tabs and Alignment */

2012-01-17T21:27:00Z

Tabs and Alignment

← Older revision		Revision as of 21:27, 17 January 2012
Line 53:		Line 53:
	=== Tabs and Alignment ===		=== Tabs and Alignment ===

	Inkscape code uses 4 spaces for indentation and no tabs anywhere.		Inkscape code uses 4 spaces for indentation and <b>no tabs anywhere</b>.

	That's clear (not to mention sensible). However, on the mail Coding Style page it says this:		That's clear (not to mention sensible). However, on the mail Coding Style page it says this:

Romain2Boss: /* User Interface Coding Rules */

2011-12-15T22:22:20Z

User Interface Coding Rules

← Older revision		Revision as of 22:22, 15 December 2011
Line 273:		Line 273:

	* Dialogs source codes have to be localized in src/ui/dialog/		* Dialogs source codes have to be localized in src/ui/dialog/
	* A dialog ~~belong~~ to the namespace Inkscape::UI::Dialog		* A dialog belongs to the namespace Inkscape::UI::Dialog

	=== Widgets ===		=== Widgets ===

	* Dialogs source codes have to be localized in src/ui/widget/		* Dialogs source codes have to be localized in src/ui/widget/
	* A ~~dialog belong~~ to the namespace Inkscape::UI::Widget		* A widget belongs to the namespace Inkscape::UI::Widget

	[[Category:Developer Discussion]]		[[Category:Developer Discussion]]

Romain2Boss: Adding User Interface Coding Rules

2011-12-15T22:18:12Z

Adding User Interface Coding Rules

← Older revision		Revision as of 22:18, 15 December 2011
Line 255:		Line 255:

	===Arguments against capitalizing===		===Arguments against capitalizing===

			== User Interface Coding Rules ==

			=== Complex User Interface Items and Containers (Dialogs, Panels, Frames...) ===

			* Each one have to be developped as a C++ class
			* Declare all UI widgets that are used in the container as protected initialisation-time allocated members
			protected:
			Gtk::Label _anchorLabel;
			* Initialize all widgets in the member initialization list of the container constructor
			MyDialog::MyDialog():
			_anchorLabel(_("Look at this label"))
			{
			...

			=== Dialogs ===

			* Dialogs source codes have to be localized in src/ui/dialog/
			* A dialog belong to the namespace Inkscape::UI::Dialog

			=== Widgets ===

			* Dialogs source codes have to be localized in src/ui/widget/
			* A dialog belong to the namespace Inkscape::UI::Widget

	[[Category:Developer Discussion]]		[[Category:Developer Discussion]]

JonCruz: /* crazyCamelCase v. Underscores */ fixed pejorative title

2011-06-25T22:08:37Z

crazyCamelCase v. Underscores: fixed pejorative title

← Older revision		Revision as of 22:08, 25 June 2011
Line 27:		Line 27:
	Then (for emacsen users), one can re-indent a region with C-M-\.		Then (for emacsen users), one can re-indent a region with C-M-\.

	=== ~~crazyCamelCase~~ v. Underscores ===		=== camelCase v. Underscores ===
	* The new coding standards require non-static member functions to be in pseudoCamelCase, and every other type of function to use underscores.		* The new coding standards require non-static member functions to be in pseudoCamelCase, and every other type of function to use underscores.
	* The current codebase has very few real C++ objects, half of these objects (or more) seem to use underscores for their member functions, the other half seem to use pseudoCamelCase.		* The current codebase has very few real C++ objects, half of these objects (or more) seem to use underscores for their member functions, the other half seem to use pseudoCamelCase.
	** Over-all, 95% of Inkscape's codebase uses underscores in function names (of ~~coures~~, 90% of the code is still C).		** Over-all, 95% of Inkscape's codebase uses underscores in function names (of course, 90% of the code is still C).
	*** It seems underscores are what Inkscape developers are already used to.		*** It seems underscores are what Inkscape developers are already used to.

	* I prefer CamelCase for type names (classes), exceptions, namespaces, and the like. But pseudoCamelCase in member functions clutters the visual space; making types, exceptions, and namescapes stand out much less. And it makes the code much harder (for me) to read.		* I prefer CamelCase for type names (classes), exceptions, namespaces, and the like. But pseudoCamelCase in member functions clutters the visual space; making types, exceptions, and namescapes stand out much less. And it makes the code much harder (for me) to read.

			** This is a personal preference. I find CamelCase to be more legible and more concise, as it takes less space and thus allows for longer identifiers. [[User:JonCruz\|JonCruz]]

	** Why is there this inconsistency with regard to function names in the new coding standard?		** Why is there this inconsistency with regard to function names in the new coding standard?
	*** (I.e., why a few functions pseudoCamelCase, and everything else underscores?)		*** (I.e., why a few functions pseudoCamelCase, and everything else underscores?)
Line 40:		Line 43:

	* Hey, we're not programming in Java (or Qt) here! This is C++, where underscore reigns supreme.		* Hey, we're not programming in Java (or Qt) here! This is C++, where underscore reigns supreme.

			** A key point here is the misconception that camel case is not a C/C++ thing. Many platforms used camel case, including the Microsoft Windows API, Apple Macintosh API, etc. [[User:JonCruz\|JonCruz]]

			** CamelCase is also prevalent in many other "non-pc" languages such as Smalltalk.

	=== Underscore as first character of identifiers ===		=== Underscore as first character of identifiers ===