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