summaryrefslogtreecommitdiffstats
path: root/Source/cmCablePackageCommand.h
blob: 8b4e9eb81e635da7615f4015818a12ec645cfaee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile$
  Language:  C++
  Date:      $Date$
  Version:   $Revision$


  Copyright (c) 2000 National Library of Medicine
  All rights reserved.

  See COPYRIGHT.txt for copyright details.

=========================================================================*/
#ifndef cmCablePackageCommand_h
#define cmCablePackageCommand_h

#include "cmStandardIncludes.h"
#include "cmCableCommand.h"

/** \class cmCablePackageCommand
 * \brief Define a command that begins a CABLE Package definition.
 *
 * cmCablePackageCommand is used to generate a new CABLE Package.
 * All subsequent commands that require a package will refer to that
 * setup by this command, until another package is started.
 */
class cmCablePackageCommand : public cmCableCommand
{
public:
  cmCablePackageCommand() {}
  virtual ~cmCablePackageCommand();

  /**
   * This is a virtual constructor for the command.
   */
  virtual cmCommand* Clone()
    {
      return new cmCablePackageCommand;
    }

  /**
   * This is called when the command is first encountered in
   * the CMakeLists.txt file.
   */
  virtual bool Invoke(std::vector<std::string>& args);  

  /**
   * This is called at the end after all the information
   * specified by the command is accumulated. Most commands do
   * not implement this method.  At this point, reading and
   * writing to the cache can be done.
   */
  virtual void FinalPass();
  
  /**
   * The name of the command as specified in CMakeList.txt.
   */
  virtual const char* GetName() { return "CABLE_PACKAGE";}

  /**
   * Succinct documentation.
   */
  virtual const char* GetTerseDocumentation() 
    {
    return "Begin a package definition.";
    }
  
  /**
   * More documentation.
   */
  virtual const char* GetFullDocumentation()
    {
    return
      "CABLE_PACKAGE(package_name target)\n"
      "Close current package (if any), and open a new package definition.";
    }  

  void WritePackageHeader() const;
  void WritePackageFooter() const;  
  const char *GetPackageName() {return m_PackageName.c_str();}
      
  cmTypeMacro(cmCablePackageCommand, cmCableCommand);
private:
  /**
   * The name of the package.
   */
  std::string m_PackageName;  
  std::string m_TargetName;  
};



#endif