src/command.c

   1 /* $Id$ */
   2
   3 /*
   4  *                            COPYRIGHT
   5  *
   6  *  PCB, interactive printed circuit board design
   7  *  Copyright (C) 1994,1995,1996, 2005 Thomas Nau
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; either version 2 of the License, or
  12  *  (at your option) any later version.
  13  *
  14  *  This program is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *  GNU General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License
  20  *  along with this program; if not, write to the Free Software
  21  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  *
  23  *  Contact addresses for paper mail and Email:
  24  *  Thomas Nau, Schlehenweg 15, 88471 Baustetten, Germany
  25  *  Thomas.Nau@rz.uni-ulm.de
  26  *
  27  */
  28
  29 /* executes commands from user
  30  */
  31
  32 #ifdef HAVE_CONFIG_H
  33 #include "config.h"
  34 #endif
  35
  36 #include <stdlib.h>
  37 #ifdef HAVE_STRING_H
  38 #include <string.h>
  39 #endif
  40 #include <ctype.h>
  41
  42 #include "global.h"
  43 #include "action.h"
  44 #include "buffer.h"
  45 #include "command.h"
  46 #include "data.h"
  47 #include "djopt.h"
  48 #include "error.h"
  49 #include "file.h"
  50 #include "mymem.h"
  51 #include "misc.h"
  52 #include "rats.h"
  53 #include "set.h"
  54 #include "vendor.h"
  55
  56 #ifdef HAVE_LIBDMALLOC
  57 #include <dmalloc.h>
  58 #endif
  59
  60 RCSID ("$Id$");
  61
  62 /* ---------------------------------------------------------------------- */
  63
  64 /*  %start-doc actions 00macros
  65
  66 @macro colonaction
  67
  68 This is one of the command box helper actions.  While it is a regular
  69 action and can be used like any other action, its name and syntax are
  70 optimized for use with the command box (@code{:}) and thus the syntax
  71 is documented for that purpose.
  72
  73 @end macro
  74
  75 %end-doc */
  76
  77 /* ---------------------------------------------------------------------- */
  78
  79 static const char h_syntax[] = "h";
  80
  81 static const char h_help[] = "Print a help message for commands.";
  82
  83 /* %start-doc actions h
  84
  85 @colonaction
  86
  87 %end-doc */
  88
  89 static int
  90 CommandHelp (int argc, char **argv, int x, int y)
  91 {
  92   Message ("following commands are supported:\n"
  93            "  Command()   execute an action command (too numerous to list)\n"
  94            "              see the manual for the list of action commands\n"
  95            "  h           display this help message\n"
  96            "  l  [file]   load layout\n"
  97            "  le [file]   load element to buffer\n"
  98            "  m  [file]   load layout to buffer (merge)\n"
  99            "  q           quits the application\n"
 100            "  q!          quits without save warning\n"
 101            "  rn [file]   read in a net-list file\n"
 102            "  s  [file]   save layout\n"
 103            "  w  [file]   save layout\n"
 104            "  wq [file]   save layout and quit\n");
 105   return (0);
 106 }
 107
 108 /* ---------------------------------------------------------------------- */
 109
 110 static const char l_syntax[] = "l [name]";
 111
 112 static const char l_help[] = "Loads layout data.";
 113
 114 /* %start-doc actions l
 115
 116 Loads a new datafile (layout) and, if confirmed, overwrites any
 117 existing unsaved data.  The filename and the searchpath
 118 (@emph{filePath}) are passed to the command defined by
 119 @emph{fileCommand}.  If no filename is specified a file select box
 120 will popup.
 121
 122 @colonaction
 123
 124 %end-doc */
 125
 126 static int
 127 CommandLoadLayout (int argc, char **argv, int x, int y)
 128 {
 129   char *filename, *name = NULL;
 130
 131   switch (argc)
 132     {
 133     case 1:                     /* filename is passed in commandline */
 134       filename = argv[0];
 135       break;
 136
 137     default:                    /* usage */
 138       Message ("Usage: l [name]\n  loads layout data\n");
 139       return (1);
 140     }
 141
 142   if (!PCB->Changed || gui->confirm_dialog ("OK to override layout data?", 0))
 143     LoadPCB (filename);
 144   free (name);
 145   return (0);
 146 }
 147
 148 /* --------------------------------------------------------------------------- */
 149
 150 static const char le_syntax[] = "le [name]";
 151
 152 static const char le_help[] = "Loads an element into the current buffer.";
 153
 154 /* %start-doc actions le
 155
 156 The filename and the searchpath (@emph{elementPath}) are passed to the
 157 command defined by @emph{elementCommand}.  If no filename is specified
 158 a file select box will popup.
 159
 160 @colonaction
 161
 162 %end-doc */
 163
 164 static int
 165 CommandLoadElementToBuffer (int argc, char **argv, int x, int y)
 166 {
 167   char *filename;
 168
 169   switch (argc)
 170     {
 171     case 1:                     /* filename is passed in commandline */
 172       filename = argv[0];
 173       if (filename && LoadElementToBuffer (PASTEBUFFER, filename, true))
 174         SetMode (PASTEBUFFER_MODE);
 175       break;
 176
 177     default:                    /* usage */
 178       Message (false, "Usage: le [name]\n  loads element data to buffer\n");
 179       return (1);
 180     }
 181   return (0);
 182 }
 183
 184 /* --------------------------------------------------------------------------- */
 185
 186 static const char m_syntax[] = "m [name]";
 187
 188 static const char m_help[] = "Loads a layout into the current buffer.";
 189
 190 /* %start-doc actions m
 191
 192 The filename and the searchpath (@emph{filePath}) are passed to the
 193 command defined by @emph{fileCommand}.
 194 If no filename is specified a file select box will popup.
 195
 196 @colonaction
 197
 198 %end-doc */
 199
 200 static int
 201 CommandLoadLayoutToBuffer (int argc, char **argv, int x, int y)
 202 {
 203   char *filename;
 204
 205   switch (argc)
 206     {
 207     case 1:                     /* filename is passed in commandline */
 208       filename = argv[0];
 209       if (filename && LoadLayoutToBuffer (PASTEBUFFER, filename))
 210         SetMode (PASTEBUFFER_MODE);
 211       break;
 212
 213     default:                    /* usage */
 214       Message ("Usage: m [name]\n  loads layout data to buffer\n");
 215       return (1);
 216     }
 217   return (0);
 218 }
 219
 220 /* --------------------------------------------------------------------------- */
 221
 222 static const char q_syntax[] = "q";
 223
 224 static const char q_help[] = "Quits the application after confirming.";
 225
 226 /* %start-doc actions q
 227
 228 If you have unsaved changes, you will be prompted to confirm (or
 229 save) before quitting.
 230
 231 @colonaction
 232
 233 %end-doc */
 234
 235 static int
 236 CommandQuit (int argc, char **argv, int x, int y)
 237 {
 238   if (!PCB->Changed || gui->close_confirm_dialog () == HID_CLOSE_CONFIRM_OK)
 239     QuitApplication ();
 240   return 0;
 241 }
 242
 243 static const char qreally_syntax[] = "q!";
 244
 245 static const char qreally_help[] =
 246   "Quits the application without confirming.";
 247
 248 /* %start-doc actions q!
 249
 250 Note that this command neither saves your data nor prompts for
 251 confirmation.
 252
 253 @colonaction
 254
 255 %end-doc */
 256
 257 static int
 258 CommandReallyQuit (int argc, char **argv, int x, int y)
 259 {
 260   QuitApplication ();
 261   return 0;
 262 }
 263
 264 /* ---------------------------------------------------------------------- */
 265
 266 static const char rn_syntax[] = "rn [name]";
 267
 268 static const char rn_help[] = "Reads netlist.";
 269
 270 /* %start-doc actions rn
 271
 272 If no filename is given a file select box will pop up.  The file is
 273 read via the command defined by the @emph{RatCommand} resource. The
 274 command must send its output to @emph{stdout}.
 275
 276 Netlists are used for generating rat's nests (see @ref{Rats Nest}) and
 277 for verifying the board layout (which is also accomplished by the
 278 @emph{Ratsnest} command).
 279
 280 @colonaction
 281
 282 %end-doc */
 283
 284 static int
 285 CommandLoadNetlist (int argc, char **argv, int x, int y)
 286 {
 287   char *filename, *name = NULL;
 288
 289   switch (argc)
 290     {
 291     case 1:                     /* filename is passed in commandline */
 292       filename = argv[0];
 293       break;
 294
 295     default:                    /* usage */
 296       Message ("Usage: rn [name]\n  reads in a netlist file\n");
 297       return (1);
 298     }
 299   if (PCB->Netlistname)
 300     free (PCB->Netlistname);
 301   PCB->Netlistname = StripWhiteSpaceAndDup (filename);
 302   free (name);
 303   return (0);
 304 }
 305
 306 /* ---------------------------------------------------------------------- */
 307
 308 static const char s_syntax[] = "s [name]";
 309
 310 static const char s_help[] = "Saves layout data.";
 311
 312 /* %start-doc actions s
 313
 314 Data and the filename are passed to the command defined by the
 315 resource @emph{saveCommand}. It must read the layout data from
 316 @emph{stdin}.  If no filename is entered, either the last one is used
 317 again or, if it is not available, a file select box will pop up.
 318
 319 @colonaction
 320
 321 %end-doc */
 322
 323 static const char w_syntax[] = "w [name]";
 324
 325 static const char w_help[] = "Saves layout data.";
 326
 327 /* %start-doc actions w
 328
 329 This commands has been added for the convenience of @code{vi} users
 330 and has the same functionality as @code{s}.
 331
 332 @colonaction
 333
 334 %end-doc */
 335
 336 static int
 337 CommandSaveLayout (int argc, char **argv, int x, int y)
 338 {
 339   switch (argc)
 340     {
 341     case 0:
 342       if (PCB->Filename)
 343         SavePCB (PCB->Filename);
 344       else
 345         Message ("No filename to save to yet\n");
 346       break;
 347
 348     case 1:
 349       SavePCB (argv[0]);
 350       break;
 351
 352     default:
 353       Message ("Usage: s [name] | w [name]\n  saves layout data\n");
 354       return (1);
 355     }
 356   return (0);
 357 }
 358
 359 /* --------------------------------------------------------------------------- */
 360
 361 static const char wq_syntax[] = "wq";
 362
 363 static const char wq_help[] = "Saves the layout data and quits.";
 364
 365 /* %start-doc actions wq
 366
 367 This command has been added for the convenience of @code{vi} users and
 368 has the same functionality as @code{s} combined with @code{q}.
 369
 370 @colonaction
 371
 372 %end-doc */
 373
 374 static int
 375 CommandSaveLayoutAndQuit (int argc, char **argv, int x, int y)
 376 {
 377   if (!CommandSaveLayout (argc, argv, x, y))
 378     return CommandQuit (0, 0, 0, 0);
 379   return (1);
 380 }
 381
 382 /* --------------------------------------------------------------------------- */
 383
 384 HID_Action command_action_list[] = {
 385   {"h", 0, CommandHelp,
 386    h_help, h_syntax}
 387   ,
 388   {"l", 0, CommandLoadLayout,
 389    l_help, l_syntax}
 390   ,
 391   {"le", 0, CommandLoadElementToBuffer,
 392    le_help, le_syntax}
 393   ,
 394   {"m", 0, CommandLoadLayoutToBuffer,
 395    m_help, m_syntax}
 396   ,
 397   {"q", 0, CommandQuit,
 398    q_help, q_syntax}
 399   ,
 400   {"q!", 0, CommandReallyQuit,
 401    qreally_help, qreally_syntax}
 402   ,
 403   {"rn", 0, CommandLoadNetlist,
 404    rn_help, rn_syntax}
 405   ,
 406   {"s", 0, CommandSaveLayout,
 407    s_help, s_syntax}
 408   ,
 409   {"w", 0, CommandSaveLayout,
 410    w_help, w_syntax}
 411   ,
 412   {"wq", 0, CommandSaveLayoutAndQuit,
 413    wq_help, wq_syntax}
 414   ,
 415 };
 416
 417 REGISTER_ACTIONS (command_action_list)