src/editor/bookmark.c

   1 /*
   2    Editor book mark handling
   3
   4    Copyright (C) 2001, 2002, 2003, 2005, 2007, 2011
   5    The Free Software Foundation, Inc.
   6
   7    Written by:
   8    Paul Sheer, 1996, 1997
   9
  10    This file is part of the Midnight Commander.
  11
  12    The Midnight Commander is free software: you can redistribute it
  13    and/or modify it under the terms of the GNU General Public License as
  14    published by the Free Software Foundation, either version 3 of the License,
  15    or (at your option) any later version.
  16
  17    The Midnight Commander is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20    GNU General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public License
  23    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24  */
  25
  26 /** \file
  27  *  \brief Source: editor book mark handling
  28  *  \author Paul Sheer
  29  *  \date 1996, 1997
  30  */
  31
  32 #include <config.h>
  33
  34 #include <ctype.h>
  35 #include <errno.h>
  36 #include <stdarg.h>
  37 #include <stdio.h>
  38 #include <stdlib.h>
  39 #include <string.h>
  40
  41 #include <sys/types.h>
  42 #include <sys/stat.h>
  43 #include <unistd.h>
  44
  45 #include "lib/global.h"
  46 #include "lib/util.h"           /* MAX_SAVED_BOOKMARKS */
  47
  48 #include "editwidget.h"
  49
  50 /*** global variables ****************************************************************************/
  51
  52 /*** file scope macro definitions ****************************************************************/
  53
  54 /*** file scope type declarations ****************************************************************/
  55
  56 /*** file scope variables ************************************************************************/
  57
  58 /*** file scope functions ************************************************************************/
  59 /* --------------------------------------------------------------------------------------------- */
  60
  61 /** note, if there is more than one bookmark on a line, then they are
  62    appended after each other and the last one is always the one found
  63    by book_mark_found() i.e. last in is the one seen */
  64
  65 static edit_book_mark_t *
  66 double_marks (WEdit * edit, edit_book_mark_t * p)
  67 {
  68     (void) edit;
  69
  70     if (p->next != NULL)
  71         while (p->next->line == p->line)
  72             p = p->next;
  73     return p;
  74 }
  75
  76 /* --------------------------------------------------------------------------------------------- */
  77 /** returns the first bookmark on or before this line */
  78
  79 edit_book_mark_t *
  80 book_mark_find (WEdit * edit, long line)
  81 {
  82     edit_book_mark_t *p;
  83
  84     if (edit->book_mark == NULL)
  85     {
  86         /* must have an imaginary top bookmark at line -1 to make things less complicated  */
  87         edit->book_mark = g_new0 (edit_book_mark_t, 1);
  88         edit->book_mark->line = -1;
  89         return edit->book_mark;
  90     }
  91
  92     for (p = edit->book_mark; p != NULL; p = p->next)
  93     {
  94         if (p->line > line)
  95             break;              /* gone past it going downward */
  96
  97         if (p->next != NULL)
  98         {
  99             if (p->next->line > line)
 100             {
 101                 edit->book_mark = p;
 102                 return double_marks (edit, p);
 103             }
 104         }
 105         else
 106         {
 107             edit->book_mark = p;
 108             return double_marks (edit, p);
 109         }
 110     }
 111
 112     for (p = edit->book_mark; p != NULL; p = p->prev)
 113     {
 114         if (p->next != NULL && p->next->line <= line)
 115             break;              /* gone past it going upward */
 116
 117         if (p->line <= line)
 118         {
 119             if (p->next != NULL)
 120             {
 121                 if (p->next->line > line)
 122                 {
 123                     edit->book_mark = p;
 124                     return double_marks (edit, p);
 125                 }
 126             }
 127             else
 128             {
 129                 edit->book_mark = p;
 130                 return double_marks (edit, p);
 131             }
 132         }
 133     }
 134
 135     return NULL;                /* can't get here */
 136 }
 137
 138 /* --------------------------------------------------------------------------------------------- */
 139 /*** public functions ****************************************************************************/
 140 /* --------------------------------------------------------------------------------------------- */
 141
 142 /**
 143  * Check if bookmark bookmark exists at this line of this color
 144  *
 145  * @param edit editor object
 146  * @param line line where book mark is
 147  * @param c color of book mark
 148  * @return TRUE if bookmark exists at this line of color c, FALSE otherwise
 149  */
 150
 151 gboolean
 152 book_mark_query_color (WEdit * edit, long line, int c)
 153 {
 154     if (edit->book_mark != NULL)
 155     {
 156         edit_book_mark_t *p;
 157
 158         for (p = book_mark_find (edit, line); p != NULL; p = p->prev)
 159         {
 160             if (p->line != line)
 161                 return FALSE;
 162             if (p->c == c)
 163                 return TRUE;
 164         }
 165     }
 166
 167     return FALSE;
 168 }
 169
 170 /* --------------------------------------------------------------------------------------------- */
 171 /** insert a bookmark at this line */
 172
 173 void
 174 book_mark_insert (WEdit * edit, long line, int c)
 175 {
 176     edit_book_mark_t *p, *q;
 177
 178     p = book_mark_find (edit, line);
 179 #if 0
 180     if (p->line == line)
 181     {
 182         /* already exists, so just change the color */
 183         if (p->c != c)
 184         {
 185             p->c = c;
 186             edit->force |= REDRAW_LINE;
 187         }
 188         return;
 189     }
 190 #endif
 191     /* create list entry */
 192     q = g_new (edit_book_mark_t, 1);
 193     q->line = line;
 194     q->c = c;
 195     q->next = p->next;
 196     /* insert into list */
 197     q->prev = p;
 198     if (p->next != NULL)
 199         p->next->prev = q;
 200     p->next = q;
 201
 202     edit->force |= REDRAW_LINE;
 203 }
 204
 205 /* --------------------------------------------------------------------------------------------- */
 206 /**
 207  * Remove a bookmark if there is one at this line matching this color - c of -1 clear all
 208  *
 209  * @param edit editor object
 210  * @param line line where book mark is
 211  * @param c color of book mark or -1 to clear all book marks on this line
 212  * @return FALSE if not found, TRUE otherwise
 213  */
 214
 215 gboolean
 216 book_mark_clear (WEdit * edit, long line, int c)
 217 {
 218     edit_book_mark_t *p, *q;
 219     gboolean r = FALSE;
 220
 221     if (edit->book_mark == NULL)
 222         return r;
 223
 224     for (p = book_mark_find (edit, line); p != NULL; p = q)
 225     {
 226         q = p->prev;
 227         if (p->line == line && (p->c == c || c == -1))
 228         {
 229             r = TRUE;
 230             edit->book_mark = p->prev;
 231             p->prev->next = p->next;
 232             if (p->next != NULL)
 233                 p->next->prev = p->prev;
 234             g_free (p);
 235             edit->force |= REDRAW_LINE;
 236             break;
 237         }
 238     }
 239     /* if there is only our dummy book mark left, clear it for speed */
 240     if (edit->book_mark->line == -1 && edit->book_mark->next == NULL)
 241     {
 242         g_free (edit->book_mark);
 243         edit->book_mark = NULL;
 244     }
 245     return r;
 246 }
 247
 248 /* --------------------------------------------------------------------------------------------- */
 249 /** clear all bookmarks matching this color, if c is -1 clears all */
 250
 251 void
 252 book_mark_flush (WEdit * edit, int c)
 253 {
 254     edit_book_mark_t *p, *q;
 255
 256     if (edit->book_mark == NULL)
 257         return;
 258
 259     while (edit->book_mark->prev != NULL)
 260         edit->book_mark = edit->book_mark->prev;
 261
 262     for (q = edit->book_mark->next; q != NULL; q = p)
 263     {
 264         p = q->next;
 265         if (q->c == c || c == -1)
 266         {
 267             q->prev->next = q->next;
 268             if (p != NULL)
 269                 p->prev = q->prev;
 270             g_free (q);
 271         }
 272     }
 273     if (edit->book_mark->next == NULL)
 274     {
 275         g_free (edit->book_mark);
 276         edit->book_mark = NULL;
 277     }
 278
 279     edit->force |= REDRAW_PAGE;
 280 }
 281
 282 /* --------------------------------------------------------------------------------------------- */
 283 /** shift down bookmarks after this line */
 284
 285 void
 286 book_mark_inc (WEdit * edit, long line)
 287 {
 288     if (edit->book_mark != NULL)
 289     {
 290         edit_book_mark_t *p;
 291
 292         p = book_mark_find (edit, line);
 293         for (p = p->next; p != NULL; p = p->next)
 294             p->line++;
 295     }
 296 }
 297
 298 /* --------------------------------------------------------------------------------------------- */
 299 /** shift up bookmarks after this line */
 300
 301 void
 302 book_mark_dec (WEdit * edit, long line)
 303 {
 304     if (edit->book_mark != NULL)
 305     {
 306         edit_book_mark_t *p;
 307
 308         p = book_mark_find (edit, line);
 309         for (p = p->next; p != NULL; p = p->next)
 310             p->line--;
 311     }
 312 }
 313
 314 /* --------------------------------------------------------------------------------------------- */
 315 /** prepare line positions of bookmarks to be saved to file */
 316
 317 void
 318 book_mark_serialize (WEdit * edit, int color)
 319 {
 320     if (edit->serialized_bookmarks != NULL)
 321         g_array_set_size (edit->serialized_bookmarks, 0);
 322
 323     if (edit->book_mark != NULL)
 324     {
 325         edit_book_mark_t *p;
 326
 327         if (edit->serialized_bookmarks == NULL)
 328             edit->serialized_bookmarks = g_array_sized_new (FALSE, FALSE, sizeof (size_t),
 329                                                             MAX_SAVED_BOOKMARKS);
 330
 331         for (p = book_mark_find (edit, 0); p != NULL; p = p->next)
 332             if (p->c == color && p->line >= 0)
 333                 g_array_append_val (edit->serialized_bookmarks, p->line);
 334     }
 335 }
 336
 337 /* --------------------------------------------------------------------------------------------- */
 338 /** restore bookmarks from saved line positions */
 339
 340 void
 341 book_mark_restore (WEdit * edit, int color)
 342 {
 343     if (edit->serialized_bookmarks != NULL)
 344     {
 345         size_t i;
 346
 347         for (i = 0; i < edit->serialized_bookmarks->len; i++)
 348             book_mark_insert (edit, g_array_index (edit->serialized_bookmarks, size_t, i), color);
 349     }
 350 }
 351
 352 /* --------------------------------------------------------------------------------------------- */