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 "CommandCStruct.h"

    41

#include "CommandData.h"

    42

#include "CommandDebug.h"

    43

#include "CommandDomains.h"

    44

#include "CommandDownload.h"

    45

#ifdef EC_EOE

    46

# include "CommandEoe.h"

    47

#endif

    48

#include "CommandFoeRead.h"

    49

#include "CommandFoeWrite.h"

    50

#include "CommandGraph.h"

    51

#include "CommandMaster.h"

    52

#include "CommandPdos.h"

    53

#include "CommandRegRead.h"

    54

#include "CommandRegWrite.h"

    55

#include "CommandSdos.h"

    56

#include "CommandSiiRead.h"

    57

#include "CommandSiiWrite.h"

    58

#include "CommandSlaves.h"

    59

#include "CommandSoeRead.h"

    60

#include "CommandSoeWrite.h"

    61

#include "CommandStates.h"

    62

#include "CommandUpload.h"

    63

#include "CommandVersion.h"

    64

#include "CommandXml.h"

    65

    66

#include "MasterDevice.h"

    67

    68

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

    69

    70

typedef list<Command *> CommandList;

    71

CommandList commandList;

    72

    73

string binaryBaseName;

    74

string commandName;

    75

Command::StringVector commandArgs;

    76

    77

// option variables

    78

string masters = "-"; // all masters

    79

int slavePosition = -1;

    80

int slaveAlias = -1;

    81

int domainIndex = -1;

    82

string dataTypeStr;

    83

Command::Verbosity verbosity = Command::Normal;

    84

bool force = false;

    85

bool helpRequested = false;

    86

string outputFile;

    87

    88

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

    89

    90

string usage()

    91

{

    92

    stringstream str;

    93

    CommandList::const_iterator ci;

    94

    size_t maxWidth = 0;

    95

    96

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

    97

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

    98

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

    99

        }

   100

    }

   101

   102

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

   103

        << endl << endl

   104

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

   105

   106

    str << left;

   107

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

   108

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

   109

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

   110

    }

   111

   112

    str << endl

   113

        << "Global options:" << endl

   114

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

   115

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

   116

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

   117

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

   118

        << endl

   119

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

   120

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

   121

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

   122

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

   123

        << endl

   124

        << Command::numericInfo()

   125

        << endl

   126

        << "Call '" << binaryBaseName

   127

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

   128

        << endl

   129

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

   130

   131

    return str.str();

   132

}

   133

   134

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

   135

   136

void getOptions(int argc, char **argv)

   137

{

   138

    int c, argCount;

   139

    stringstream str;

   140

   141

    static struct option longOptions[] = {

   142

        //name,         has_arg,           flag, val

   143

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

   144

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

   145

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

   146

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

   147

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

   148

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

   149

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

   150

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

   151

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

   152

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

   153

        {}

   154

    };

   155

   156

    do {

   157

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

   158

   159

        switch (c) {

   160

            case 'm':

   161

                masters = optarg;

   162

                break;

   163

   164

            case 'a':

   165

                str.clear();

   166

                str.str("");

   167

                str << optarg;

   168

                str >> resetiosflags(ios::basefield) // guess base from prefix

   169

                    >> slaveAlias;

   170

                if (str.fail() || slaveAlias < 0 || slaveAlias > 0xFFFF) {

   171

                    cerr << "Invalid slave alias " << optarg << "!" << endl

   172

                        << endl << usage();

   173

                    exit(1);

   174

                }

   175

                break;

   176

   177

            case 'p':

   178

                str.clear();

   179

                str.str("");

   180

                str << optarg;

   181

                str >> resetiosflags(ios::basefield) // guess base from prefix

   182

                    >> slavePosition;

   183

                if (str.fail()

   184

                        || slavePosition < 0 || slavePosition > 0xFFFF) {

   185

                    cerr << "Invalid slave position " << optarg << "!" << endl

   186

                        << endl << usage();

   187

                    exit(1);

   188

                }

   189

                break;

   190

   191

            case 'd':

   192

                str.clear();

   193

                str.str("");

   194

                str << optarg;

   195

                str >> resetiosflags(ios::basefield) // guess base from prefix

   196

                    >> domainIndex;

   197

                if (str.fail() || domainIndex < 0) {

   198

                    cerr << "Invalid domain index " << optarg << "!" << endl

   199

                        << endl << usage();

   200

                    exit(1);

   201

                }

   202

                break;

   203

   204

            case 't':

   205

                dataTypeStr = optarg;

   206

                break;

   207

   208

            case 'o':

   209

                outputFile = optarg;

   210

                break;

   211

   212

            case 'f':

   213

                force = true;

   214

                break;

   215

   216

            case 'q':

   217

                verbosity = Command::Quiet;

   218

                break;

   219

   220

            case 'v':

   221

                verbosity = Command::Verbose;

   222

                break;

   223

   224

            case 'h':

   225

                helpRequested = true;

   226

                break;

   227

   228

            case '?':

   229

                cerr << endl << usage();

   230

                exit(1);

   231

   232

            default:

   233

                break;

   234

        }

   235

    }

   236

    while (c != -1);

   237

   238

    argCount = argc - optind;

   239

   240

    if (!argCount) {

   241

        if (helpRequested) {

   242

            cout << usage();

   243

            exit(0);

   244

        } else {

   245

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

   246

                << endl << usage();

   247

            exit(1);

   248

        }

   249

    }

   250

   251

    commandName = argv[optind];

   252

    while (++optind < argc)

   253

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

   254

}

   255

   256

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

   257

   258

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

   259

{

   260

    CommandList::iterator ci;

   261

    list<Command *> res;

   262

   263

    // find matching commands from beginning of the string

   264

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

   265

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

   266

            res.push_back(*ci);

   267

        }

   268

    }

   269

   270

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

   271

        // find /any/ matching commands

   272

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

   273

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

   274

                res.push_back(*ci);

   275

            }

   276

        }

   277

    }

   278

   279

    return res;

   280

}

   281

   282

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

   283

   284

int main(int argc, char **argv)

   285

{

   286

    int retval = 0;

   287

    list<Command *> matchingCommands;

   288

    list<Command *>::const_iterator ci;

   289

    Command *cmd;

   290

   291

    binaryBaseName = basename(argv[0]);

   292

   293

    commandList.push_back(new CommandAlias());

   294

    commandList.push_back(new CommandConfig());

   295

    commandList.push_back(new CommandCStruct());

   296

    commandList.push_back(new CommandData());

   297

    commandList.push_back(new CommandDebug());

   298

    commandList.push_back(new CommandDomains());

   299

    commandList.push_back(new CommandDownload());

   300

#ifdef EC_EOE

   301

    commandList.push_back(new CommandEoe());

   302

#endif

   303

    commandList.push_back(new CommandFoeRead());

   304

    commandList.push_back(new CommandFoeWrite());

   305

    commandList.push_back(new CommandGraph());

   306

    commandList.push_back(new CommandMaster());

   307

    commandList.push_back(new CommandPdos());

   308

    commandList.push_back(new CommandRegRead());

   309

    commandList.push_back(new CommandRegWrite());

   310

    commandList.push_back(new CommandSdos());

   311

    commandList.push_back(new CommandSiiRead());

   312

    commandList.push_back(new CommandSiiWrite());

   313

    commandList.push_back(new CommandSlaves());

   314

    commandList.push_back(new CommandSoeRead());

   315

    commandList.push_back(new CommandSoeWrite());

   316

    commandList.push_back(new CommandStates());

   317

    commandList.push_back(new CommandUpload());

   318

    commandList.push_back(new CommandVersion());

   319

    commandList.push_back(new CommandXml());

   320

   321

    getOptions(argc, argv);

   322

   323

    matchingCommands = getMatchingCommands(commandName);

   324

   325

    if (matchingCommands.size()) {

   326

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

   327

            cmd = matchingCommands.front();

   328

            if (!helpRequested) {

   329

                try {

   330

                    cmd->setMasters(masters);

   331

                    cmd->setVerbosity(verbosity);

   332

                    cmd->setAlias(slaveAlias);

   333

                    cmd->setPosition(slavePosition);

   334

                    cmd->setDomain(domainIndex);

   335

                    cmd->setDataType(dataTypeStr);

   336

                    cmd->setOutputFile(outputFile);

   337

                    cmd->setForce(force);

   338

                    cmd->execute(commandArgs);

   339

                } catch (InvalidUsageException &e) {

   340

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

   341

                    cerr << binaryBaseName << " " << cmd->helpString();

   342

                    retval = 1;

   343

                } catch (CommandException &e) {

   344

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

   345

                    retval = 1;

   346

                } catch (MasterDeviceException &e) {

   347

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

   348

                    retval = 1;

   349

                }

   350

            } else {

   351

                cout << binaryBaseName << " " << cmd->helpString();

   352

            }

   353

        } else {

   354

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

   355

            for (ci = matchingCommands.begin();

   356

                    ci != matchingCommands.end();

   357

                    ci++) {

   358

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

   359

            }

   360

            cerr << endl << usage();

   361

            retval = 1;

   362

        }

   363

    } else {

   364

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

   365

            << endl << usage();

   366

        retval = 1;

   367

    }

   368

   369

    return retval;

   370

}

   371

   372

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