src/verbs.h

   1 #ifndef SEEN_SP_VERBS_H
   2 #define SEEN_SP_VERBS_H
   3
   4 /** \file
   5  * \brief Frontend to actions
   6  *
   7  * Author:
   8  *   Lauris Kaplinski <lauris@kaplinski.com>
   9  *   Ted Gould <ted@gould.cx>
  10  *   David Yip <yipdw@rose-hulman.edu>
  11  *
  12  *  Copyright (C) 2006 Johan Engelen <johan@shouraizou.nl>
  13  *  Copyright (C) (date unspecified) Authors
  14
  15  * This code is in public domain if done by Lauris
  16  * This code is GPL if done by Ted or David
  17  */
  18
  19 #include <cstring>
  20 #include <string>
  21 #include <string.h>
  22 #include "config.h"
  23 #include "require-config.h"   /* HAVE_GTK_WINDOW_FULLSCREEN */
  24 #include "helper/helper-forward.h"
  25 #include "forward.h"
  26 #include <glibmm/ustring.h>
  27
  28 /** \brief This anonymous enum is used to provide a list of the Verbs
  29            which are defined staticly in the verb files.  There may be
  30            other verbs which are defined dynamically also. */
  31 enum {
  32     /* Header */
  33     SP_VERB_INVALID,               /**< A dummy verb to represent doing something wrong. */
  34     SP_VERB_NONE,                  /**< A dummy verb to represent not having a verb. */
  35     /* File */
  36     SP_VERB_FILE_NEW,              /**< A new file in a new window. */
  37     SP_VERB_FILE_OPEN,             /**< Open a file. */
  38     SP_VERB_FILE_REVERT,           /**< Revert this file to its original state. */
  39     SP_VERB_FILE_SAVE,             /**< Save the current file with its saved filename */
  40     SP_VERB_FILE_SAVE_AS,          /**< Save the current file with a new filename */
  41     SP_VERB_FILE_SAVE_A_COPY,      /**< Save a copy of the current file */
  42     SP_VERB_FILE_PRINT,
  43     SP_VERB_FILE_VACUUM,
  44     SP_VERB_FILE_PRINT_PREVIEW,
  45     SP_VERB_FILE_IMPORT,
  46     SP_VERB_FILE_EXPORT,
  47     SP_VERB_FILE_IMPORT_FROM_OCAL, /**< Import the file from Open Clip Art Library */
  48 //    SP_VERB_FILE_EXPORT_TO_OCAL, /**< Export the file to Open Clip Art  Library */
  49     SP_VERB_FILE_NEXT_DESKTOP,
  50     SP_VERB_FILE_PREV_DESKTOP,
  51     SP_VERB_FILE_CLOSE_VIEW,
  52     SP_VERB_FILE_QUIT,
  53     /* Edit */
  54     SP_VERB_EDIT_UNDO,
  55     SP_VERB_EDIT_REDO,
  56     SP_VERB_EDIT_CUT,
  57     SP_VERB_EDIT_COPY,
  58     SP_VERB_EDIT_PASTE,
  59     SP_VERB_EDIT_PASTE_STYLE,
  60     SP_VERB_EDIT_PASTE_SIZE,
  61     SP_VERB_EDIT_PASTE_SIZE_X,
  62     SP_VERB_EDIT_PASTE_SIZE_Y,
  63     SP_VERB_EDIT_PASTE_SIZE_SEPARATELY,
  64     SP_VERB_EDIT_PASTE_SIZE_SEPARATELY_X,
  65     SP_VERB_EDIT_PASTE_SIZE_SEPARATELY_Y,
  66     SP_VERB_EDIT_PASTE_IN_PLACE,
  67     SP_VERB_EDIT_PASTE_LIVEPATHEFFECT,
  68     SP_VERB_EDIT_REMOVE_LIVEPATHEFFECT,
  69     SP_VERB_EDIT_REMOVE_FILTER,
  70     SP_VERB_EDIT_DELETE,
  71     SP_VERB_EDIT_DUPLICATE,
  72     SP_VERB_EDIT_CLONE,
  73     SP_VERB_EDIT_UNLINK_CLONE,
  74     SP_VERB_EDIT_RELINK_CLONE,
  75     SP_VERB_EDIT_CLONE_SELECT_ORIGINAL,
  76     SP_VERB_EDIT_SELECTION_2_MARKER,
  77     SP_VERB_EDIT_SELECTION_2_GUIDES,
  78     SP_VERB_EDIT_TILE,
  79     SP_VERB_EDIT_UNTILE,
  80     SP_VERB_EDIT_CLEAR_ALL,
  81     SP_VERB_EDIT_SELECT_ALL,
  82     SP_VERB_EDIT_SELECT_ALL_IN_ALL_LAYERS,
  83     SP_VERB_EDIT_INVERT,
  84     SP_VERB_EDIT_INVERT_IN_ALL_LAYERS,
  85     SP_VERB_EDIT_SELECT_NEXT,
  86     SP_VERB_EDIT_SELECT_PREV,
  87     SP_VERB_EDIT_DESELECT,
  88     SP_VERB_EDIT_GUIDES_AROUND_PAGE,
  89     SP_VERB_EDIT_NEXT_PATHEFFECT_PARAMETER,
  90     /* Selection */
  91     SP_VERB_SELECTION_TO_FRONT,
  92     SP_VERB_SELECTION_TO_BACK,
  93     SP_VERB_SELECTION_RAISE,
  94     SP_VERB_SELECTION_LOWER,
  95     SP_VERB_SELECTION_GROUP,
  96     SP_VERB_SELECTION_UNGROUP,
  97     SP_VERB_SELECTION_TEXTTOPATH,
  98     SP_VERB_SELECTION_TEXTFROMPATH,
  99     SP_VERB_SELECTION_REMOVE_KERNS,
 100     SP_VERB_SELECTION_UNION,
 101     SP_VERB_SELECTION_INTERSECT,
 102     SP_VERB_SELECTION_DIFF,
 103     SP_VERB_SELECTION_SYMDIFF,
 104     SP_VERB_SELECTION_CUT,
 105     SP_VERB_SELECTION_SLICE,
 106     SP_VERB_SELECTION_OFFSET,
 107     SP_VERB_SELECTION_OFFSET_SCREEN,
 108     SP_VERB_SELECTION_OFFSET_SCREEN_10,
 109     SP_VERB_SELECTION_INSET,
 110     SP_VERB_SELECTION_INSET_SCREEN,
 111     SP_VERB_SELECTION_INSET_SCREEN_10,
 112     SP_VERB_SELECTION_DYNAMIC_OFFSET,
 113     SP_VERB_SELECTION_LINKED_OFFSET,
 114     SP_VERB_SELECTION_OUTLINE,
 115     SP_VERB_SELECTION_SIMPLIFY,
 116     SP_VERB_SELECTION_REVERSE,
 117     SP_VERB_SELECTION_TRACE,
 118     SP_VERB_SELECTION_CREATE_BITMAP,
 119     SP_VERB_SELECTION_COMBINE,
 120     SP_VERB_SELECTION_BREAK_APART,
 121     SP_VERB_SELECTION_GRIDTILE,
 122     /* Layer */
 123     SP_VERB_LAYER_NEW,
 124     SP_VERB_LAYER_RENAME,
 125     SP_VERB_LAYER_NEXT,
 126     SP_VERB_LAYER_PREV,
 127     SP_VERB_LAYER_MOVE_TO_NEXT,
 128     SP_VERB_LAYER_MOVE_TO_PREV,
 129     SP_VERB_LAYER_TO_TOP,
 130     SP_VERB_LAYER_TO_BOTTOM,
 131     SP_VERB_LAYER_RAISE,
 132     SP_VERB_LAYER_LOWER,
 133     SP_VERB_LAYER_DUPLICATE,
 134     SP_VERB_LAYER_DELETE,
 135     SP_VERB_LAYER_SOLO,
 136     /* Object */
 137     SP_VERB_OBJECT_ROTATE_90_CW,
 138     SP_VERB_OBJECT_ROTATE_90_CCW,
 139     SP_VERB_OBJECT_FLATTEN,
 140     SP_VERB_OBJECT_TO_CURVE,
 141     SP_VERB_OBJECT_FLOW_TEXT,
 142     SP_VERB_OBJECT_UNFLOW_TEXT,
 143     SP_VERB_OBJECT_FLOWTEXT_TO_TEXT,
 144     SP_VERB_OBJECT_FLIP_HORIZONTAL,
 145     SP_VERB_OBJECT_FLIP_VERTICAL,
 146     SP_VERB_OBJECT_SET_MASK,
 147     SP_VERB_OBJECT_EDIT_MASK,
 148     SP_VERB_OBJECT_UNSET_MASK,
 149     SP_VERB_OBJECT_SET_CLIPPATH,
 150     SP_VERB_OBJECT_EDIT_CLIPPATH,
 151     SP_VERB_OBJECT_UNSET_CLIPPATH,
 152     /* Tools */
 153     SP_VERB_CONTEXT_SELECT,
 154     SP_VERB_CONTEXT_NODE,
 155     SP_VERB_CONTEXT_TWEAK,
 156     SP_VERB_CONTEXT_SPRAY,
 157     SP_VERB_CONTEXT_RECT,
 158     SP_VERB_CONTEXT_3DBOX,
 159     SP_VERB_CONTEXT_ARC,
 160     SP_VERB_CONTEXT_STAR,
 161     SP_VERB_CONTEXT_SPIRAL,
 162     SP_VERB_CONTEXT_PENCIL,
 163     SP_VERB_CONTEXT_PEN,
 164     SP_VERB_CONTEXT_CALLIGRAPHIC,
 165     SP_VERB_CONTEXT_TEXT,
 166     SP_VERB_CONTEXT_GRADIENT,
 167     SP_VERB_CONTEXT_ZOOM,
 168     SP_VERB_CONTEXT_DROPPER,
 169     SP_VERB_CONTEXT_CONNECTOR,
 170     SP_VERB_CONTEXT_PAINTBUCKET,
 171     SP_VERB_CONTEXT_LPE, /* not really a tool but used for editing LPE parameters on-canvas for example */
 172     SP_VERB_CONTEXT_ERASER,
 173     SP_VERB_CONTEXT_LPETOOL, /* note that this is very different from SP_VERB_CONTEXT_LPE above! */
 174     /* Tool preferences */
 175     SP_VERB_CONTEXT_SELECT_PREFS,
 176     SP_VERB_CONTEXT_NODE_PREFS,
 177     SP_VERB_CONTEXT_TWEAK_PREFS,
 178     SP_VERB_CONTEXT_SPRAY_PREFS,
 179     SP_VERB_CONTEXT_RECT_PREFS,
 180     SP_VERB_CONTEXT_3DBOX_PREFS,
 181     SP_VERB_CONTEXT_ARC_PREFS,
 182     SP_VERB_CONTEXT_STAR_PREFS,
 183     SP_VERB_CONTEXT_SPIRAL_PREFS,
 184     SP_VERB_CONTEXT_PENCIL_PREFS,
 185     SP_VERB_CONTEXT_PEN_PREFS,
 186     SP_VERB_CONTEXT_CALLIGRAPHIC_PREFS,
 187     SP_VERB_CONTEXT_TEXT_PREFS,
 188     SP_VERB_CONTEXT_GRADIENT_PREFS,
 189     SP_VERB_CONTEXT_ZOOM_PREFS,
 190     SP_VERB_CONTEXT_DROPPER_PREFS,
 191     SP_VERB_CONTEXT_CONNECTOR_PREFS,
 192     SP_VERB_CONTEXT_PAINTBUCKET_PREFS,
 193     SP_VERB_CONTEXT_ERASER_PREFS,
 194     SP_VERB_CONTEXT_LPETOOL_PREFS,
 195     /* Zooming and desktop settings */
 196     SP_VERB_ZOOM_IN,
 197     SP_VERB_ZOOM_OUT,
 198     SP_VERB_TOGGLE_RULERS,
 199     SP_VERB_TOGGLE_SCROLLBARS,
 200     SP_VERB_TOGGLE_GRID,
 201     SP_VERB_TOGGLE_GUIDES,
 202     SP_VERB_TOGGLE_SNAPPING,
 203     SP_VERB_ZOOM_NEXT,
 204     SP_VERB_ZOOM_PREV,
 205     SP_VERB_ZOOM_1_1,
 206     SP_VERB_ZOOM_1_2,
 207     SP_VERB_ZOOM_2_1,
 208 #ifdef HAVE_GTK_WINDOW_FULLSCREEN
 209     SP_VERB_FULLSCREEN,
 210 #endif /* HAVE_GTK_WINDOW_FULLSCREEN */
 211     SP_VERB_FOCUSTOGGLE,
 212     SP_VERB_VIEW_NEW,
 213     SP_VERB_VIEW_NEW_PREVIEW,
 214     SP_VERB_VIEW_MODE_NORMAL,
 215     SP_VERB_VIEW_MODE_NO_FILTERS,
 216     SP_VERB_VIEW_MODE_OUTLINE,
 217     SP_VERB_VIEW_MODE_TOGGLE,
 218     SP_VERB_VIEW_CMS_TOGGLE,
 219     SP_VERB_VIEW_ICON_PREVIEW,
 220     SP_VERB_ZOOM_PAGE,
 221     SP_VERB_ZOOM_PAGE_WIDTH,
 222     SP_VERB_ZOOM_DRAWING,
 223     SP_VERB_ZOOM_SELECTION,
 224     /* Dialogs */
 225     SP_VERB_DIALOG_DISPLAY,
 226     SP_VERB_DIALOG_NAMEDVIEW,
 227     SP_VERB_DIALOG_METADATA,
 228     SP_VERB_DIALOG_FILL_STROKE,
 229     SP_VERB_DIALOG_SWATCHES,
 230     SP_VERB_DIALOG_TRANSFORM,
 231     SP_VERB_DIALOG_ALIGN_DISTRIBUTE,
 232     SP_VERB_DIALOG_SPRAY_OPTION,
 233     SP_VERB_DIALOG_UNDO_HISTORY,
 234     SP_VERB_DIALOG_TEXT,
 235     SP_VERB_DIALOG_XML_EDITOR,
 236     SP_VERB_DIALOG_FIND,
 237     SP_VERB_DIALOG_FINDREPLACE,
 238     SP_VERB_DIALOG_SPELLCHECK,
 239     SP_VERB_DIALOG_DEBUG,
 240     SP_VERB_DIALOG_SCRIPT,
 241     SP_VERB_DIALOG_TOGGLE,
 242     SP_VERB_DIALOG_CLONETILER,
 243     SP_VERB_DIALOG_ITEM,
 244 /*#ifdef WITH_INKBOARD
 245     SP_VERB_XMPP_CLIENT,
 246 #endif*/
 247     SP_VERB_DIALOG_INPUT,
 248     SP_VERB_DIALOG_INPUT2,
 249     SP_VERB_DIALOG_EXTENSIONEDITOR,
 250     SP_VERB_DIALOG_LAYERS,
 251     SP_VERB_DIALOG_LIVE_PATH_EFFECT,
 252     SP_VERB_DIALOG_FILTER_EFFECTS,
 253     SP_VERB_DIALOG_SVG_FONTS,
 254     /* Help */
 255     SP_VERB_HELP_ABOUT_EXTENSIONS,
 256     SP_VERB_HELP_MEMORY,
 257     SP_VERB_HELP_ABOUT,
 258     //SP_VERB_SHOW_LICENSE,
 259     /* Tutorials */
 260     SP_VERB_TUTORIAL_BASIC,
 261     SP_VERB_TUTORIAL_SHAPES,
 262     SP_VERB_TUTORIAL_ADVANCED,
 263     SP_VERB_TUTORIAL_TRACING,
 264     SP_VERB_TUTORIAL_CALLIGRAPHY,
 265     SP_VERB_TUTORIAL_DESIGN,
 266     SP_VERB_TUTORIAL_TIPS,
 267     /* Effects */
 268     SP_VERB_EFFECT_LAST,
 269     SP_VERB_EFFECT_LAST_PREF,
 270     /* Fit Canvas */
 271     SP_VERB_FIT_CANVAS_TO_SELECTION,
 272     SP_VERB_FIT_CANVAS_TO_DRAWING,
 273     SP_VERB_FIT_CANVAS_TO_SELECTION_OR_DRAWING,
 274     /* LockAndHide */
 275     SP_VERB_UNLOCK_ALL,
 276     SP_VERB_UNLOCK_ALL_IN_ALL_LAYERS,
 277     SP_VERB_UNHIDE_ALL,
 278     SP_VERB_UNHIDE_ALL_IN_ALL_LAYERS,
 279     /* Color management */
 280     SP_VERB_EDIT_LINK_COLOR_PROFILE,
 281     SP_VERB_EDIT_REMOVE_COLOR_PROFILE,
 282     /*Scripting*/
 283     SP_VERB_EDIT_ADD_EXTERNAL_SCRIPT,
 284     SP_VERB_EDIT_REMOVE_EXTERNAL_SCRIPT,
 285     /* Footer */
 286     SP_VERB_LAST
 287 };
 288
 289 gchar *sp_action_get_title (const SPAction *action);
 290
 291 #include <map>
 292
 293 namespace Inkscape {
 294
 295 /** \brief A class to represent things the user can do.  In many ways
 296            these are 'action factories' as they are used to create
 297            individual actions that are based on a given view.
 298 */
 299 class Verb {
 300 private:
 301     /** \brief An easy to use defition of the table of verbs by code. */
 302     typedef std::map<unsigned int, Inkscape::Verb *> VerbTable;
 303     /** \brief A table of all the dynamically created verbs. */
 304     static VerbTable _verbs;
 305     /** \brief The table of statically created verbs which are mostly
 306                'base verbs'. */
 307     static Verb * _base_verbs[SP_VERB_LAST + 1];
 308     /* Plus one because there is an entry for SP_VERB_LAST */
 309     /** A string comparison function to be used in the Verb ID lookup
 310         to find the different verbs in the hash map. */
 311     struct ltstr {
 312         bool operator()(const char* s1, const char* s2) const {
 313             if ( (s1 == NULL) && (s2 != NULL) ) {
 314                 return true;
 315             } else if (s1 == NULL || s2 == NULL) {
 316                 return false;
 317             } else {
 318                 return strcmp(s1, s2) < 0;
 319             }
 320         }
 321     };
 322     /** \brief An easy to use definition of the table of verbs by ID. */
 323     typedef std::map<gchar const *, Verb *, ltstr> VerbIDTable;
 324     /** \brief Quick lookup of verbs by ID */
 325     static VerbIDTable _verb_ids;
 326
 327     /** \brief A simple typedef to make using the action table easier. */
 328     typedef std::map<Inkscape::UI::View::View *, SPAction *> ActionTable;
 329     /** \brief A list of all the actions that have been created for this
 330                verb.  It is referenced by the view that they are created for. */
 331     ActionTable * _actions;
 332
 333     /** \brief A unique textual ID for the verb. */
 334     gchar const * _id;
 335     /** \brief The full name of the verb.  (shown on menu entries) */
 336     gchar const * _name;
 337     /** \brief Tooltip for the verb. */
 338     gchar const * _tip;
 339     /** \brief Name of the image that represents the verb. */
 340     gchar const * _image;
 341     /** \brief Unique numerical representation of the verb.  In most cases
 342                it is a value from the anonymous enum at the top of this
 343                file. */
 344     unsigned int  _code;
 345
 346     /** \brief Whether this verb is set to default to sensitive or
 347                insensitive when new actions are created. */
 348     bool _default_sensitive;
 349 protected:
 350     /** \brief Allows for preliminary setting of the \c _default_sensitive
 351                value without effecting existing actions
 352         \param in_val New value
 353
 354         This function is mostly used at initialization where there are
 355         not actions to effect.  I can't think of another case where it
 356         should be used.
 357     */
 358     bool set_default_sensitive (bool in_val) { return _default_sensitive = in_val; }
 359 public:
 360     /** \brief Accessor to get the \c _default_sensitive value */
 361     bool get_default_sensitive (void) { return _default_sensitive; }
 362
 363 public:
 364     /** \brief Accessor to get the internal variable. */
 365     unsigned int get_code (void) { return _code; }
 366     /** \brief Accessor to get the internal variable. */
 367     gchar const * get_id (void) { return _id; }
 368     /** \brief Accessor to get the internal variable. */
 369     gchar const * get_name (void) { return _name; }
 370     /** \brief Accessor to get the internal variable. */
 371     gchar const * get_tip (void) ;
 372     /** \brief Accessor to get the internal variable. */
 373     gchar const * get_image (void) { return _image; }
 374
 375     /** \brief Set the name after initialization. */
 376     gchar const * set_name (gchar const * name) { _name = name; return _name; }
 377     /** \brief Set the tooltip after initialization. */
 378     gchar const * set_tip (gchar const * tip) { _tip = tip; return _tip; }
 379
 380 protected:
 381     SPAction * make_action_helper (Inkscape::UI::View::View * view, SPActionEventVector * vector, void * in_pntr = NULL);
 382     virtual SPAction * make_action (Inkscape::UI::View::View * view);
 383
 384 public:
 385     /** \brief Inititalizes the Verb with the parameters
 386         \param code  Goes to \c _code
 387         \param id    Goes to \c _id
 388         \param name  Goes to \c _name
 389         \param tip   Goes to \c _tip
 390         \param image Goes to \c _image
 391
 392         This function also sets \c _actions to NULL.
 393
 394         \warning NO DATA IS COPIED BY CALLING THIS FUNCTION.
 395
 396         In many respects this is very bad object oriented design, but it
 397         is done for a reason.  All verbs today are of two types: 1) static
 398         or 2) created for extension.  In the static case all of the
 399         strings are constants in the code, and thus don't really need to
 400         be copied.  In the extensions case the strings are identical to
 401         the ones already created in the extension object, copying them
 402         would be a waste of memory.
 403     */
 404     Verb(const unsigned int code,
 405          gchar const * id,
 406          gchar const * name,
 407          gchar const * tip,
 408          gchar const * image) :
 409         _actions(NULL), _id(id), _name(name), _tip(tip), _image(image), _code(code), _default_sensitive(true) {
 410         _verbs.insert(VerbTable::value_type(_code, this));
 411         _verb_ids.insert(VerbIDTable::value_type(_id, this));
 412     }
 413     Verb (gchar const * id, gchar const * name, gchar const * tip, gchar const * image);
 414     virtual ~Verb (void);
 415
 416     SPAction * get_action(Inkscape::UI::View::View * view);
 417
 418 private:
 419     static Verb * get_search (unsigned int code);
 420 public:
 421     /** \brief A function to turn a code into a verb.
 422         \param  code  The code to be translated
 423         \return A pointer to a verb object or a NULL if not found.
 424
 425         This is an inline function to translate the codes which are
 426         static quickly.  This should optimize into very quick code
 427         everywhere which hard coded \c codes are used.  In the case
 428         where the \c code is not static the \c get_search function
 429         is used.
 430     */
 431     static Verb * get (unsigned int code) {
 432         if (code <= SP_VERB_LAST) {
 433             return _base_verbs[code];
 434         } else {
 435             return get_search(code);
 436         }
 437     }
 438     static Verb * getbyid (gchar const * id);
 439
 440     static void delete_all_view (Inkscape::UI::View::View * view);
 441     void delete_view (Inkscape::UI::View::View * view);
 442
 443     void sensitive (SPDocument * in_doc = NULL, bool in_sensitive = true);
 444     void name (SPDocument * in_doc = NULL, Glib::ustring in_name = "");
 445
 446 // Yes, multiple public, protected and private sections are bad. We'll clean that up later
 447 protected:
 448     /** \brief Returns the size of the internal base verb array.
 449         \return The size in elements of the internal base array.
 450
 451         This is an inline function intended for testing. This should normally not be used.
 452         For testing, a subclass that returns this value can be created to verify that the
 453         length matches the enum values, etc.
 454     */
 455     static int _getBaseListSize(void) {return G_N_ELEMENTS(_base_verbs);}
 456
 457 public:
 458     static void list (void);
 459 }; /* Verb class */
 460
 461
 462 }  /* Inkscape namespace */
 463
 464 #endif // SEEN_SP_VERBS_H
 465
 466 /*
 467   Local Variables:
 468   mode:c++
 469   c-file-style:"stroustrup"
 470   c-file-offsets:((innamespace . 0)(inline-open . 0))
 471   indent-tabs-mode:nil
 472   fill-column:99
 473   End:
 474 */
 475 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :