1

/*****************************************************************************

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2009  Florian Pose, Ingenieurgemeinschaft IgH

     6

 *

     7

 *  This file is part of the IgH EtherCAT Master.

     8

 *

     9

 *  The IgH EtherCAT Master is free software; you can redistribute it and/or

    10

 *  modify it under the terms of the GNU General Public License version 2, as

    11

 *  published by the Free Software Foundation.

    12

 *

    13

 *  The IgH EtherCAT Master is distributed in the hope that it will be useful,

    14

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General

    16

 *  Public License for more details.

    17

 *

    18

 *  You should have received a copy of the GNU General Public License along

    19

 *  with the IgH EtherCAT Master; if not, write to the Free Software

    20

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    21

 *

    22

 *  ---

    23

 *

    24

 *  The license mentioned above concerns the source code only. Using the

    25

 *  EtherCAT technology and brand is only permitted in compliance with the

    26

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    27

 *

    28

 ****************************************************************************/

    29

    30

#include <getopt.h>

    31

#include <libgen.h> // basename()

    32

#include <stdlib.h>

    33

    34

#include <iostream>

    35

#include <iomanip>

    36

using namespace std;

    37

    38

#include "CommandAlias.h"

    39

#include "CommandConfig.h"

    40

#include "CommandCrc.h"

    41

#include "CommandCStruct.h"

    42

#include "CommandData.h"

    43

#include "CommandDebug.h"

    44

#include "CommandDomains.h"

    45

#include "CommandDownload.h"

    46

#ifdef EC_EOE

    47

# include "CommandEoe.h"

    48

#endif

    49

#include "CommandFoeRead.h"

    50

#include "CommandFoeWrite.h"

    51

#include "CommandGraph.h"

    52

#include "CommandIp.h"

    53

#include "CommandMaster.h"

    54

#include "CommandPdos.h"

    55

#include "CommandRegRead.h"

    56

#include "CommandRegWrite.h"

    57

#include "CommandRescan.h"

    58

#include "CommandSdos.h"

    59

#include "CommandSiiRead.h"

    60

#include "CommandSiiWrite.h"

    61

#include "CommandSlaves.h"

    62

#include "CommandSoeRead.h"

    63

#include "CommandSoeWrite.h"

    64

#include "CommandStates.h"

    65

#include "CommandUpload.h"

    66

#include "CommandVersion.h"

    67

#include "CommandXml.h"

    68

    69

#include "MasterDevice.h"

    70

    71

/*****************************************************************************/

    72

    73

typedef list<Command *> CommandList;

    74

CommandList commandList;

    75

    76

string binaryBaseName;

    77

string commandName;

    78

Command::StringVector commandArgs;

    79

    80

// option variables

    81

string masters = "-"; // all masters

    82

string positions = "-"; // all positions

    83

string aliases = "-"; // all aliases

    84

string domains = "-"; // all domains

    85

string dataTypeStr;

    86

Command::Verbosity verbosity = Command::Normal;

    87

bool force = false;

    88

bool emergency = false;

    89

bool helpRequested = false;

    90

string outputFile;

    91

string skin;

    92

    93

/*****************************************************************************/

    94

    95

string usage()

    96

{

    97

    stringstream str;

    98

    CommandList::const_iterator ci;

    99

    size_t maxWidth = 0;

   100

   101

    for (ci = commandList.begin(); ci != commandList.end(); ci++) {

   102

        if ((*ci)->getName().length() > maxWidth) {

   103

            maxWidth = (*ci)->getName().length();

   104

        }

   105

    }

   106

   107

    str << "Usage: " << binaryBaseName << " <COMMAND> [OPTIONS] [ARGUMENTS]"

   108

        << endl << endl

   109

        << "Commands (can be abbreviated):" << endl;

   110

   111

    str << left;

   112

    for (ci = commandList.begin(); ci != commandList.end(); ci++) {

   113

        str << "  " << setw(maxWidth) << (*ci)->getName()

   114

            << "  " << (*ci)->getBriefDescription() << endl;

   115

    }

   116

   117

    str << endl

   118

        << "Global options:" << endl

   119

        << "  --master  -m <master>  Comma separated list of masters" << endl

   120

        << "                         to select, ranges are allowed." << endl

   121

        << "                         Examples: '1,3', '5-7,9', '-3'." << endl

   122

        << "                         Default: '-' (all)."

   123

        << endl

   124

        << "  --force   -f           Force a command." << endl

   125

        << "  --quiet   -q           Output less information." << endl

   126

        << "  --verbose -v           Output more information." << endl

   127

        << "  --help    -h           Show this help." << endl

   128

        << endl

   129

        << Command::numericInfo()

   130

        << endl

   131

        << "Call '" << binaryBaseName

   132

        << " <COMMAND> --help' for command-specific help." << endl

   133

        << endl

   134

        << "Send bug reports to " << PACKAGE_BUGREPORT << "." << endl;

   135

   136

    return str.str();

   137

}

   138

   139

/*****************************************************************************/

   140

   141

void getOptions(int argc, char **argv)

   142

{

   143

    int c, argCount;

   144

    stringstream str;

   145

   146

    static struct option longOptions[] = {

   147

        //name,         has_arg,           flag, val

   148

        {"master",      required_argument, NULL, 'm'},

   149

        {"alias",       required_argument, NULL, 'a'},

   150

        {"position",    required_argument, NULL, 'p'},

   151

        {"domain",      required_argument, NULL, 'd'},

   152

        {"type",        required_argument, NULL, 't'},

   153

        {"output-file", required_argument, NULL, 'o'},

   154

        {"skin",        required_argument, NULL, 's'},

   155

        {"emergency",   no_argument,       NULL, 'e'},

   156

        {"force",       no_argument,       NULL, 'f'},

   157

        {"quiet",       no_argument,       NULL, 'q'},

   158

        {"verbose",     no_argument,       NULL, 'v'},

   159

        {"help",        no_argument,       NULL, 'h'},

   160

        {}

   161

    };

   162

   163

    do {

   164

        c = getopt_long(argc, argv, "m:a:p:d:t:o:s:efqvh", longOptions, NULL);

   165

   166

        switch (c) {

   167

            case 'm':

   168

                masters = optarg;

   169

                break;

   170

   171

            case 'a':

   172

                aliases = optarg;

   173

                break;

   174

   175

            case 'p':

   176

                positions = optarg;

   177

                break;

   178

   179

            case 'd':

   180

                domains = optarg;

   181

                break;

   182

   183

            case 't':

   184

                dataTypeStr = optarg;

   185

                break;

   186

   187

            case 'o':

   188

                outputFile = optarg;

   189

                break;

   190

   191

            case 's':

   192

                skin = optarg;

   193

                break;

   194

   195

            case 'e':

   196

                emergency = true;

   197

                break;

   198

   199

            case 'f':

   200

                force = true;

   201

                break;

   202

   203

            case 'q':

   204

                verbosity = Command::Quiet;

   205

                break;

   206

   207

            case 'v':

   208

                verbosity = Command::Verbose;

   209

                break;

   210

   211

            case 'h':

   212

                helpRequested = true;

   213

                break;

   214

   215

            case '?':

   216

                cerr << endl << usage();

   217

                exit(1);

   218

   219

            default:

   220

                break;

   221

        }

   222

    }

   223

    while (c != -1);

   224

   225

    argCount = argc - optind;

   226

   227

    if (!argCount) {

   228

        if (helpRequested) {

   229

            cout << usage();

   230

            exit(0);

   231

        } else {

   232

            cerr << "Please specify a command!" << endl

   233

                << endl << usage();

   234

            exit(1);

   235

        }

   236

    }

   237

   238

    commandName = argv[optind];

   239

    while (++optind < argc)

   240

        commandArgs.push_back(string(argv[optind]));

   241

}

   242

   243

/****************************************************************************/

   244

   245

list<Command *> getMatchingCommands(const string &cmdStr)

   246

{

   247

    CommandList::iterator ci;

   248

    list<Command *> res;

   249

   250

    // find matching commands from beginning of the string

   251

    for (ci = commandList.begin(); ci != commandList.end(); ci++) {

   252

        if ((*ci)->matchesSubstr(cmdStr)) {

   253

            res.push_back(*ci);

   254

        }

   255

    }

   256

   257

    if (!res.size()) { // nothing found

   258

        // find /any/ matching commands

   259

        for (ci = commandList.begin(); ci != commandList.end(); ci++) {

   260

            if ((*ci)->matchesAbbrev(cmdStr)) {

   261

                res.push_back(*ci);

   262

            }

   263

        }

   264

    }

   265

   266

    return res;

   267

}

   268

   269

/****************************************************************************/

   270

   271

int main(int argc, char **argv)

   272

{

   273

    int retval = 0;

   274

    list<Command *> matchingCommands;

   275

    list<Command *>::const_iterator ci;

   276

    Command *cmd;

   277

   278

    binaryBaseName = basename(argv[0]);

   279

   280

    commandList.push_back(new CommandAlias());

   281

    commandList.push_back(new CommandConfig());

   282

    commandList.push_back(new CommandCrc());

   283

    commandList.push_back(new CommandCStruct());

   284

    commandList.push_back(new CommandData());

   285

    commandList.push_back(new CommandDebug());

   286

    commandList.push_back(new CommandDomains());

   287

    commandList.push_back(new CommandDownload());

   288

#ifdef EC_EOE

   289

    commandList.push_back(new CommandEoe());

   290

#endif

   291

    commandList.push_back(new CommandFoeRead());

   292

    commandList.push_back(new CommandFoeWrite());

   293

    commandList.push_back(new CommandGraph());

   294

    commandList.push_back(new CommandIp());

   295

    commandList.push_back(new CommandMaster());

   296

    commandList.push_back(new CommandPdos());

   297

    commandList.push_back(new CommandRegRead());

   298

    commandList.push_back(new CommandRegWrite());

   299

    commandList.push_back(new CommandRescan());

   300

    commandList.push_back(new CommandSdos());

   301

    commandList.push_back(new CommandSiiRead());

   302

    commandList.push_back(new CommandSiiWrite());

   303

    commandList.push_back(new CommandSlaves());

   304

    commandList.push_back(new CommandSoeRead());

   305

    commandList.push_back(new CommandSoeWrite());

   306

    commandList.push_back(new CommandStates());

   307

    commandList.push_back(new CommandUpload());

   308

    commandList.push_back(new CommandVersion());

   309

    commandList.push_back(new CommandXml());

   310

   311

    getOptions(argc, argv);

   312

   313

    matchingCommands = getMatchingCommands(commandName);

   314

   315

    if (matchingCommands.size()) {

   316

        if (matchingCommands.size() == 1) {

   317

            cmd = matchingCommands.front();

   318

            if (!helpRequested) {

   319

                try {

   320

                    cmd->setMasters(masters);

   321

                    cmd->setVerbosity(verbosity);

   322

                    cmd->setAliases(aliases);

   323

                    cmd->setPositions(positions);

   324

                    cmd->setDomains(domains);

   325

                    cmd->setDataType(dataTypeStr);

   326

                    cmd->setOutputFile(outputFile);

   327

                    cmd->setSkin(skin);

   328

                    cmd->setEmergency(emergency);

   329

                    cmd->setForce(force);

   330

                    cmd->execute(commandArgs);

   331

                } catch (InvalidUsageException &e) {

   332

                    cerr << e.what() << endl << endl;

   333

                    cerr << cmd->helpString(binaryBaseName);

   334

                    retval = 1;

   335

                } catch (CommandException &e) {

   336

                    cerr << e.what() << endl;

   337

                    retval = 1;

   338

                } catch (MasterDeviceException &e) {

   339

                    cerr << e.what() << endl;

   340

                    retval = 1;

   341

                }

   342

            } else {

   343

                cout << cmd->helpString(binaryBaseName);

   344

            }

   345

        } else {

   346

            cerr << "Ambiguous command abbreviation! Matching:" << endl;

   347

            for (ci = matchingCommands.begin();

   348

                    ci != matchingCommands.end();

   349

                    ci++) {

   350

                cerr << (*ci)->getName() << endl;

   351

            }

   352

            cerr << endl << usage();

   353

            retval = 1;

   354

        }

   355

    } else {

   356

        cerr << "Unknown command " << commandName << "!" << endl

   357

            << endl << usage();

   358

        retval = 1;

   359

    }

   360

   361

    return retval;

   362

}

   363

   364

/****************************************************************************/