SF.net SVN: geany-plugins:[1297] trunk/geanygendoc/src/ggd.c

[colombanw at users.sourceforge.net]

Revision: 1297
          http://geany-plugins.svn.sourceforge.net/geany-plugins/?rev=1297&view=rev
Author:   colombanw
Date:     2010-04-24 21:48:11 +0000 (Sat, 24 Apr 2010)

Log Message:
-----------
GeanyGenDoc: Add cursor positioning support

Add support for the special "cursor" variable in templates, allowing
to explicitly place the cursor in the generated comment.
This variable may appear more than once but currently only the first
occurrence that appears in the output comment is honored.

Modified Paths:
--------------
    trunk/geanygendoc/src/ggd.c

Modified: trunk/geanygendoc/src/ggd.c
===================================================================
--- trunk/geanygendoc/src/ggd.c	2010-04-24 21:47:44 UTC (rev 1296)
+++ trunk/geanygendoc/src/ggd.c	2010-04-24 21:48:11 UTC (rev 1297)
@@ -32,6 +32,12 @@
 #include "ggd-plugin.h"
 
 
+/* The value that replace the "cursor" variable in templates, used to find it
+ * and therefore the cursor position. This should be a value that the user never
+ * want to output; otherwise it would behave strangely from the user point of
+ * view, since it is removed from the output. */
+#define GGD_CURSOR_IDENTIFIER     "{cursor}"
+#define GGD_CURSOR_IDENTIFIER_LEN 8
 
 /* wrapper for ctpl_parser_parse() that returns a string. Free with g_free() */
 static gchar *
@@ -135,6 +141,7 @@
   GList       *children = NULL;
   
   env = ctpl_environ_new ();
+  ctpl_environ_push_string (env, "cursor", GGD_CURSOR_IDENTIFIER);
   ctpl_environ_push_string (env, "symbol", tag->name);
   /* get arguments & return type if appropriate */
   if (tag->type & (tm_tag_function_t |
@@ -208,7 +215,8 @@
 get_comment (GgdFileType   *ft,
              GgdDocSetting *setting,
              GPtrArray     *tag_array,
-             const TMTag   *tag)
+             const TMTag   *tag,
+             gint          *cursor_offset)
 {
   gchar *comment = NULL;
   
@@ -222,6 +230,19 @@
     if (! comment) {
       msgwin_status_add (_("Failed to build comment: %s"), err->message);
       g_error_free (err);
+    } else {
+      gchar *cursor_str;
+      
+      cursor_str = strstr (comment, GGD_CURSOR_IDENTIFIER);
+      if (cursor_str && cursor_offset) {
+        *cursor_offset = cursor_str - comment;
+      }
+      /* remove the cursor identifier(s) from the final comment */
+      while (cursor_str) {
+        memmove (cursor_str, cursor_str + GGD_CURSOR_IDENTIFIER_LEN,
+                 strlen (cursor_str) - GGD_CURSOR_IDENTIFIER_LEN + 1);
+        cursor_str = strstr (cursor_str, GGD_CURSOR_IDENTIFIER);
+      }
     }
   }
   
@@ -291,8 +312,9 @@
 {
   gboolean  success = FALSE;
   gchar    *comment;
+  gint      cursor_offset = 0;
   
-  comment = get_comment (ft, setting, tag_array, tag);
+  comment = get_comment (ft, setting, tag_array, tag, &cursor_offset);
   if (comment) {
     gint pos;
     
@@ -315,6 +337,7 @@
         break;
     }
     sci_insert_text (sci, pos, comment);
+    sci_set_current_position (sci, pos + cursor_offset, TRUE);
     success = TRUE;
   }
   g_free (comment);


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.