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

    47

#include "CommandPdos.h"

    48

#include "CommandPhyRead.h"

    49

#include "CommandPhyWrite.h"

    50

#include "CommandSdos.h"

    51

#include "CommandSiiRead.h"

    52

#include "CommandSiiWrite.h"

    53

#include "CommandSlaves.h"

    54

#include "CommandStates.h"

    55

#include "CommandUpload.h"

    56

#include "CommandVersion.h"

    57

#include "CommandXml.h"

    58

    59

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

    60

    61

typedef list<Command *> CommandList;

    62

CommandList commandList;

    63

    64

MasterDevice masterDev;

    65

    66

string binaryBaseName;

    67

string commandName;

    68

Command::StringVector commandArgs;

    69

    70

// option variables

    71

unsigned int masterIndex = 0;

    72

int slavePosition = -1;

    73

int slaveAlias = -1;

    74

int domainIndex = -1;

    75

string dataTypeStr;

    76

Command::Verbosity verbosity = Command::Normal;

    77

bool force = false;

    78

bool helpRequested = false;

    79

string outputFile;

    80

    81

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

    82

    83

string usage()

    84

{

    85

    stringstream str;

    86

    CommandList::const_iterator ci;

    87

    size_t maxWidth = 0;

    88

    89

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

    90

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

    91

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

    92

        }

    93

    }

    94

    95

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

    96

        << endl << endl

    97

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

    98

    99

    str << left;

   100

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

   101

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

   102

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

   103

    }

   104

   105

    str << endl

   106

		<< "Global options:" << endl

   107

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

   108

		<< endl

   109

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

   110

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

   111

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

   112

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

   113

        << endl

   114

        << Command::numericInfo()

   115

        << endl

   116

        << "Call '" << binaryBaseName

   117

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

   118

        << endl

   119

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

   120

   121

    return str.str();

   122

}

   123

   124

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

   125

   126

void getOptions(int argc, char **argv)

   127

{

   128

    int c, argCount;

   129

    stringstream str;

   130

   131

    static struct option longOptions[] = {

   132

        //name,         has_arg,           flag, val

   133

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

   134

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

   135

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

   136

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

   137

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

   138

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

   139

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

   140

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

   141

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

   142

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

   143

        {}

   144

    };

   145

   146

    do {

   147

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

   148

   149

        switch (c) {

   150

            case 'm':

   151

                str.clear();

   152

                str.str("");

   153

                str << optarg;

   154

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

   155

                    >> masterIndex;

   156

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

   157

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

   158

                        << endl << usage();

   159

                    exit(1);

   160

                }

   161

                break;

   162

   163

            case 'a':

   164

                str.clear();

   165

                str.str("");

   166

                str << optarg;

   167

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

   168

                    >> slaveAlias;

   169

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

   170

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

   171

                        << endl << usage();

   172

                    exit(1);

   173

                }

   174

                break;

   175

   176

            case 'p':

   177

                str.clear();

   178

                str.str("");

   179

                str << optarg;

   180

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

   181

                    >> slavePosition;

   182

                if (str.fail()

   183

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

   184

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

   185

                        << endl << usage();

   186

                    exit(1);

   187

                }

   188

                break;

   189

   190

            case 'd':

   191

                str.clear();

   192

                str.str("");

   193

                str << optarg;

   194

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

   195

                    >> domainIndex;

   196

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

   197

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

   198

                        << endl << usage();

   199

                    exit(1);

   200

                }

   201

                break;

   202

   203

            case 't':

   204

                dataTypeStr = optarg;

   205

                break;

   206

   207

            case 'o':

   208

                outputFile = optarg;

   209

                break;

   210

   211

            case 'f':

   212

                force = true;

   213

                break;

   214

   215

            case 'q':

   216

                verbosity = Command::Quiet;

   217

                break;

   218

   219

            case 'v':

   220

                verbosity = Command::Verbose;

   221

                break;

   222

   223

            case 'h':

   224

                helpRequested = true;

   225

                break;

   226

   227

            case '?':

   228

                cerr << endl << usage();

   229

                exit(1);

   230

   231

            default:

   232

                break;

   233

        }

   234

    }

   235

    while (c != -1);

   236

   237

	argCount = argc - optind;

   238

   239

    if (!argCount) {

   240

        if (helpRequested) {

   241

            cout << usage();

   242

            exit(0);

   243

        } else {

   244

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

   245

                << endl << usage();

   246

            exit(1);

   247

        }

   248

	}

   249

   250

    commandName = argv[optind];

   251

    while (++optind < argc)

   252

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

   253

}

   254

   255

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

   256

   257

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

   258

{

   259

    CommandList::iterator ci;

   260

    list<Command *> res;

   261

   262

    // find matching commands from beginning of the string

   263

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

   264

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

   265

            res.push_back(*ci);

   266

        }

   267

    }

   268

   269

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

   270

        // find /any/ matching commands

   271

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

   272

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

   273

                res.push_back(*ci);

   274

            }

   275

        }

   276

    }

   277

   278

    return res;

   279

}

   280

   281

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

   282

   283

int main(int argc, char **argv)

   284

{

   285

    int retval = 0;

   286

    list<Command *> matchingCommands;

   287

    list<Command *>::const_iterator ci;

   288

    Command *cmd;

   289

   290

    binaryBaseName = basename(argv[0]);

   291

   292

    commandList.push_back(new CommandAlias());

   293

    commandList.push_back(new CommandConfig());

   294

    commandList.push_back(new CommandData());

   295

    commandList.push_back(new CommandDebug());

   296

    commandList.push_back(new CommandDomains());

   297

    commandList.push_back(new CommandDownload());

   298

    commandList.push_back(new CommandFoeRead());

   299

    commandList.push_back(new CommandFoeWrite());

   300

    commandList.push_back(new CommandMaster());

   301

    commandList.push_back(new CommandPdos());

   302

    commandList.push_back(new CommandPhyRead());

   303

    commandList.push_back(new CommandPhyWrite());

   304

    commandList.push_back(new CommandSdos());

   305

    commandList.push_back(new CommandSiiRead());

   306

    commandList.push_back(new CommandSiiWrite());

   307

    commandList.push_back(new CommandSlaves());

   308

    commandList.push_back(new CommandStates());

   309

    commandList.push_back(new CommandUpload());

   310

    commandList.push_back(new CommandVersion());

   311

    commandList.push_back(new CommandXml());

   312

   313

	getOptions(argc, argv);

   314

   315

    matchingCommands = getMatchingCommands(commandName);

   316

    masterDev.setIndex(masterIndex);

   317

   318

    if (matchingCommands.size()) {

   319

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

   320

            cmd = matchingCommands.front();

   321

            if (!helpRequested) {

   322

                try {

   323

                    cmd->setVerbosity(verbosity);

   324

                    cmd->setAlias(slaveAlias);

   325

                    cmd->setPosition(slavePosition);

   326

                    cmd->setDomain(domainIndex);

   327

                    cmd->setDataType(dataTypeStr);

   328

                    cmd->setOutputFile(outputFile);

   329

                    cmd->setForce(force);

   330

                    cmd->execute(masterDev, commandArgs);

   331

                } catch (InvalidUsageException &e) {

   332

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

   333

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

   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 << binaryBaseName << " " << cmd->helpString();

   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

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