Add new "Lineoperations" plugin #324

smostertdev · 2016-01-08T22:37:28Z

LineOperations is a plugin that gives a bunch of simple functions that can be applied to a document.
(remove duplicate lines, empty lines, lines with only whitespace, sort lines...)

It is intended to be a convenient way to use these functions for non-technical users.
I am thinking of adding some more useful functions (e.g. similar to TextFX in Notepad++).

Take a look and let me know what you think, I'm open to suggestions for improvements.

smostertdev · 2016-01-09T05:29:16Z

Alright, this should now compile with autotools. (Thanks for your help @frlan )
The README file was also re-written in reStructuredText. bd2293f

frlan · 2016-01-09T09:41:02Z

Ca you please rebase your pr against current master and repush it?

b4n · 2016-01-10T02:07:11Z

lineoperations/src/linefunctions.c

+	nfposn        = 0;
+	k             = 0;
+
+	if(newfile && lines)    // verify memory allocation


g_malloc() aborts on failure. If you really mean to support allocation failure you need to use g_try_malloc() instead (no need unless you allocate really large data, as on very low memory situations something in GLib/GTK/Geany will most likely abort anyway).

Thanks, this is now updated. I decided to keep g_malloc and remove the null check since it is unnecessary as "GLib/GTK/Geany will most likely abort anyways.

Signed-off-by: Sylvan Mostert <[email protected]>

The plugin version is bumped to 225.

b4n · 2016-01-13T19:14:42Z

lineoperations/README

+        Line 1\n #NOT removed (contains non whitespace chars)
+    Line 2\n
+
+  The **Remove Unique Lines** will change the file into this:


Here too, reference should probably be "Remove Whitespace Lines"

Added `ensure_final_newline()` to add a newline if it does not exist before operation. If the final line does not have an newline, and it shifts position, the resulting line will be concatenation of two lines. Added null terminating character to new_file string in case of empty file.

b4n · 2016-01-16T13:25:47Z

lineoperations/src/lineoperations.c

+
+
+void
+lo_cleanup(void)


should be static, and signature should be static void lo_cleanup(GeanyPlugin *plugin, gpointer pdata)

See http://www.geany.org/manual/reference/structGeanyPluginFuncs.html

(and http://www.geany.org/manual/reference/howto.html)

Switched `sci_get_line_indentation()` to `SCI_GETLINEINDENTPOSITION`.

Added 'static' keyword for `lo_cleanup`. Added `main_locale_init(LOCALEDIR, GETTEXT_PACKAGE)` for the translation information.

b4n · 2016-01-17T13:57:32Z

lineoperations/src/lineoperations.c

+	g_signal_connect(rmdupln_item, "activate", G_CALLBACK(action_rmdupln_item), NULL);
+	g_signal_connect(rmunqln_item, "activate", G_CALLBACK(action_rmunqln_item), NULL);
+	g_signal_connect(rmemtyln_item, "activate", G_CALLBACK(action_rmemtyln_item), NULL);
+	g_signal_connect(rmwhspln_item, "activate", G_CALLBACK(action_rmwhspln_item), NULL);


you could lower duplication of the wrapper callbacks by having a single callback that calls the appropriate function (either passed as parameter [1] or referenced as an ID or something), as they all have they all behave the same (but the sort ones).
You may or may not want this, it's merely a suggestion. And it's even a bad one if you expect to alter the various functions to receive different parameters in the future.

[1] technically in plain C you're not supposed to convert a function pointer to a data pointer. However, GTK depends on this and it effectively works on all supported platforms (if not all platforms in general).

Done in b4n@f05a05b if you're interested. The patch however depends on the simplified menu building, so you might want to apply it afterward, or just use this as inspiration (or not at all).

b4n · 2016-01-17T14:28:47Z

lineoperations/src/linefunctions.c

+
+	total_num_chars = sci_get_length(doc->editor->sci);
+	total_num_lines = sci_get_line_count(doc->editor->sci);
+	lines           = g_malloc(sizeof(gchar *) * total_num_lines+1);


there's a subtle bug here: the +1 is not applied correctly as * has priority over +. Wrap in parentheses. (thanks to Valgrind for finding this)

Fix available at b4n@ee35465

An overlooked operator priority lead to underallocating `sizeof(gchar*)-1` bytes, later leading to an invalid memory access.

Removed trailing spaces, and changed all indents to tabs.

b4n · 2016-01-17T18:14:05Z

lineoperations/src/lineoperations.c

+	plugin->info->name        = _("Line Operations");
+	plugin->info->description = _("Line Operations provides a handful of functions that can be applied to a document such as, removing duplicate lines, removing empty lines, removing lines with only whitespace, and sorting lines.");
+	plugin->info->version     = "0.1";
+	plugin->info->author      = _("Sylvan Mostert <[email protected]>");


there probably is no need to translate your name :)

b4n · 2016-01-17T18:14:37Z

LGTM

Add new "Lineoperations" plugin

frlan added the pending fixes label Jan 8, 2016

frlan added this to the 1.27 milestone Jan 8, 2016

b4n reviewed Jan 10, 2016
View reviewed changes

smostertdev and others added 7 commits January 10, 2016 00:44

0.1 initial commit

3c637bc

Added Comments/documentation

41a53a4

Signed-off-by: Sylvan Mostert <[email protected]>

Removed translation

b35c6ec

Add LineOperations to MAINTAINERS and po/POTFILES.in

21e56cd

Remove waf scripts

de04352

Fix build with autotools

7f40949

lineoperations: Changed markup to reST

318f0bd

smostertdev force-pushed the lineoperations branch from bd2293f to 318f0bd Compare January 10, 2016 05:45

smostertdev added 5 commits January 12, 2016 10:33

lineoperations: removed g_malloc() NULL checks

25a3d4b

lineoperations: removed g_free() NULL checks

4221284

lineoperations: removed GTK2_only check

5996b8e

lineoperations: put space in title

5e04a45

The plugin version is bumped to 225.

lineoperations: added _mnemonic characters to menu

037ed2c

b4n reviewed Jan 13, 2016
View reviewed changes

smostertdev added 4 commits January 15, 2016 17:14

lineoperations: fixes to plugin API

53a5941

lineoperations: fix comment style to match project

13da575

lineoperations: changed g_strcmp0() to strcmp()

2e2e043

smostertdev force-pushed the lineoperations branch 2 times, most recently from d0f4fd2 to 8ff44b7 Compare January 16, 2016 04:42

b4n reviewed Jan 16, 2016
View reviewed changes

smostertdev added 3 commits January 16, 2016 23:05

lineoperations: switched functions in rmwhspln()

2c2cfac

Switched `sci_get_line_indentation()` to `SCI_GETLINEINDENTPOSITION`.

lineoperations: cleaned up README file

0241373

lineoperations: add translatable plugin info

5cd5c4c

Added 'static' keyword for `lo_cleanup`. Added `main_locale_init(LOCALEDIR, GETTEXT_PACKAGE)` for the translation information.

smostertdev force-pushed the lineoperations branch from 2691a29 to 5cd5c4c Compare January 17, 2016 04:38

b4n reviewed Jan 17, 2016
View reviewed changes

b4n added 2 commits January 17, 2016 15:16

lineoperations: Simplify menu building

de106a6

lineoperations: Make wrapper callbacks more generic

f05a05b

b4n reviewed Jan 17, 2016
View reviewed changes

lineoperations: Fix underallocation in sortlines()

ee35465

An overlooked operator priority lead to underallocating `sizeof(gchar*)-1` bytes, later leading to an invalid memory access.

b4n added the new-plugin label Jan 17, 2016

lineoperations: general formatting/cleanup

115fdb2

Removed trailing spaces, and changed all indents to tabs.

b4n reviewed Jan 17, 2016
View reviewed changes

b4n removed the pending fixes label Jan 17, 2016

frlan added a commit that referenced this pull request Jan 17, 2016

Merge pull request #324 from smostertdev/lineoperations

7c1d98d

Add new "Lineoperations" plugin

frlan merged commit 7c1d98d into geany:master Jan 17, 2016

smostertdev deleted the lineoperations branch January 19, 2016 07:03

hg2581 mentioned this pull request May 30, 2023

Feature request HTML Characters plugin #1250

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new "Lineoperations" plugin #324

Add new "Lineoperations" plugin #324

smostertdev commented Jan 8, 2016

smostertdev commented Jan 9, 2016

frlan commented Jan 9, 2016

b4n Jan 10, 2016

smostertdev Jan 12, 2016

b4n Jan 13, 2016

b4n Jan 16, 2016

b4n Jan 16, 2016

b4n Jan 16, 2016

b4n Jan 17, 2016

b4n Jan 17, 2016

b4n Jan 17, 2016

b4n Jan 17, 2016

b4n Jan 17, 2016

b4n commented Jan 17, 2016



		void
		lo_cleanup(void)

Add new "Lineoperations" plugin #324

Add new "Lineoperations" plugin #324

Conversation

smostertdev commented Jan 8, 2016

smostertdev commented Jan 9, 2016

frlan commented Jan 9, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

b4n commented Jan 17, 2016