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

    41

#include "CommandDebug.h"

    42

#include "CommandDomains.h"

    43

#include "CommandDownload.h"

    44

#include "CommandFoeRead.h"

    45

#include "CommandFoeWrite.h"

    46

#include "CommandGraph.h"

    47

#include "CommandMaster.h"

    48

#include "CommandPdos.h"

    49

#include "CommandRegRead.h"

    50

#include "CommandRegWrite.h"

    51

#include "CommandSdos.h"

    52

#include "CommandSiiRead.h"

    53

#include "CommandSiiWrite.h"

    54

#include "CommandSlaves.h"

    55

#include "CommandStates.h"

    56

#include "CommandUpload.h"

    57

#include "CommandVersion.h"

    58

#include "CommandXml.h"

    59

    60

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

    61

    62

typedef list<Command *> CommandList;

    63

CommandList commandList;

    64

    65

MasterDevice masterDev;

    66

    67

string binaryBaseName;

    68

string commandName;

    69

Command::StringVector commandArgs;

    70

    71

// option variables

    72

unsigned int masterIndex = 0;

    73

int slavePosition = -1;

    74

int slaveAlias = -1;

    75

int domainIndex = -1;

    76

string dataTypeStr;

    77

Command::Verbosity verbosity = Command::Normal;

    78

bool force = false;

    79

bool helpRequested = false;

    80

string outputFile;

    81

    82

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

    83

    84

string usage()

    85

{

    86

    stringstream str;

    87

    CommandList::const_iterator ci;

    88

    size_t maxWidth = 0;

    89

    90

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

    91

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

    92

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

    93

        }

    94

    }

    95

    96

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

    97

        << endl << endl

    98

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

    99

   100

    str << left;

   101

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

   102

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

   103

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

   104

    }

   105

   106

    str << endl

   107

		<< "Global options:" << endl

   108

        << "  --master  -m <master>  Index of the master to use. Default: 0."

   109

		<< endl

   110

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

   111

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

   112

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

   113

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

   114

        << endl

   115

        << Command::numericInfo()

   116

        << endl

   117

        << "Call '" << binaryBaseName

   118

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

   119

        << endl

   120

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

   121

   122

    return str.str();

   123

}

   124

   125

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

   126

   127

void getOptions(int argc, char **argv)

   128

{

   129

    int c, argCount;

   130

    stringstream str;

   131

   132

    static struct option longOptions[] = {

   133

        //name,         has_arg,           flag, val

   134

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

   135

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

   136

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

   137

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

   138

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

   139

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

   140

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

   141

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

   142

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

   143

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

   144

        {}

   145

    };

   146

   147

    do {

   148

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

   149

   150

        switch (c) {

   151

            case 'm':

   152

                str.clear();

   153

                str.str("");

   154

                str << optarg;

   155

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

   156

                    >> masterIndex;

   157

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

   158

                    cerr << "Invalid master number " << optarg << "!" << endl

   159

                        << endl << usage();

   160

                    exit(1);

   161

                }

   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 CommandData());

   296

    commandList.push_back(new CommandDebug());

   297

    commandList.push_back(new CommandDomains());

   298

    commandList.push_back(new CommandDownload());

   299

    commandList.push_back(new CommandFoeRead());

   300

    commandList.push_back(new CommandFoeWrite());

   301

    commandList.push_back(new CommandGraph());

   302

    commandList.push_back(new CommandMaster());

   303

    commandList.push_back(new CommandPdos());

   304

    commandList.push_back(new CommandRegRead());

   305

    commandList.push_back(new CommandRegWrite());

   306

    commandList.push_back(new CommandSdos());

   307

    commandList.push_back(new CommandSiiRead());

   308

    commandList.push_back(new CommandSiiWrite());

   309

    commandList.push_back(new CommandSlaves());

   310

    commandList.push_back(new CommandStates());

   311

    commandList.push_back(new CommandUpload());

   312

    commandList.push_back(new CommandVersion());

   313

    commandList.push_back(new CommandXml());

   314

   315

	getOptions(argc, argv);

   316

   317

    matchingCommands = getMatchingCommands(commandName);

   318

    masterDev.setIndex(masterIndex);

   319

   320

    if (matchingCommands.size()) {

   321

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

   322

            cmd = matchingCommands.front();

   323

            if (!helpRequested) {

   324

                try {

   325

                    cmd->setVerbosity(verbosity);

   326

                    cmd->setAlias(slaveAlias);

   327

                    cmd->setPosition(slavePosition);

   328

                    cmd->setDomain(domainIndex);

   329

                    cmd->setDataType(dataTypeStr);

   330

                    cmd->setOutputFile(outputFile);

   331

                    cmd->setForce(force);

   332

                    cmd->execute(masterDev, commandArgs);

   333

                } catch (InvalidUsageException &e) {

   334

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

   335

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

   336

                    retval = 1;

   337

                } catch (CommandException &e) {

   338

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

   339

                    retval = 1;

   340

                } catch (MasterDeviceException &e) {

   341

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

   342

                    retval = 1;

   343

                }

   344

            } else {

   345

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

   346

            }

   347

        } else {

   348

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

   349

            for (ci = matchingCommands.begin();

   350

                    ci != matchingCommands.end();

   351

                    ci++) {

   352

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

   353

            }

   354

            cerr << endl << usage();

   355

            retval = 1;

   356

        }

   357

    } else {

   358

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

   359

            << endl << usage();

   360

        retval = 1;

   361

    }

   362

   363

	return retval;

   364

}

   365

   366

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