Source/cmExportLibraryDependencies.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmExportLibraryDependencies.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-01-23 15:27:59 $
   7   Version:   $Revision: 1.9 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #ifndef cmExportLibraryDependenciesCommand_h
  18 #define cmExportLibraryDependenciesCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmExportLibraryDependenciesCommand
  23  * \brief Add a test to the lists of tests to run.
  24  *
  25  * cmExportLibraryDependenciesCommand adds a test to the list of tests to run
  26  *
  27  */
  28 class cmExportLibraryDependenciesCommand : public cmCommand
  29 {
  30 public:
  31   /**
  32    * This is a virtual constructor for the command.
  33    */
  34   virtual cmCommand* Clone()
  35     {
  36     return new cmExportLibraryDependenciesCommand;
  37     }
  38
  39   /**
  40    * This is called when the command is first encountered in
  41    * the CMakeLists.txt file.
  42    */
  43   virtual bool InitialPass(std::vector<std::string> const& args,
  44                            cmExecutionStatus &status);
  45
  46   /**
  47    * This is called at the end after all the information
  48    * specified by the command is accumulated.
  49    */
  50   virtual void FinalPass();
  51
  52   /**
  53    * The name of the command as specified in CMakeList.txt.
  54    */
  55   virtual const char* GetName() { return "export_library_dependencies";}
  56
  57   /**
  58    * Succinct documentation.
  59    */
  60   virtual const char* GetTerseDocumentation()
  61     {
  62     return
  63       "Write out the dependency information for all targets of a project.";
  64     }
  65
  66   /**
  67    * More documentation.
  68    */
  69   virtual const char* GetFullDocumentation()
  70     {
  71     return
  72       "  export_library_dependencies(<file> [APPEND])\n"
  73       "Create a file named <file> that can be included into a CMake listfile "
  74       "with the INCLUDE command.  The file will contain a number of SET "
  75       "commands that will set all the variables needed for library dependency "
  76       "information.  This should be the last command in the top level "
  77       "CMakeLists.txt file of the project.  If the APPEND option is "
  78       "specified, the SET commands will be appended to the given file "
  79       "instead of replacing it.";
  80     }
  81
  82   cmTypeMacro(cmExportLibraryDependenciesCommand, cmCommand);
  83
  84 private:
  85   std::string Filename;
  86   bool Append;
  87   void ConstFinalPass() const;
  88 };
  89
  90
  91 #endif