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