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