Source/cmSourceGroup.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmSourceGroup.h,v $
   5   Language:  C++
   6   Date:      $Date: 2006-03-15 16:02:07 $
   7   Version:   $Revision: 1.19 $
   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 cmSourceGroup_h
  18 #define cmSourceGroup_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include <cmsys/RegularExpression.hxx>
  22
  23 class cmSourceFile;
  24
  25 /** \class cmSourceGroup
  26  * \brief Hold a group of sources as specified by a SOURCE_GROUP command.
  27  *
  28  * cmSourceGroup holds a regular expression and a list of files.  When
  29  * local generators are about to generate the rules for a target's
  30  * files, the set of source groups is consulted to group files
  31  * together.  A file is placed into the last source group that lists
  32  * the file by name.  If no group lists the file, it is placed into
  33  * the last group whose regex matches it.
  34  */
  35 class cmSourceGroup
  36 {
  37 public:
  38   cmSourceGroup(const char* name, const char* regex);
  39   ~cmSourceGroup() {}
  40
  41   /**
  42    * Set the regular expression for this group.
  43    */
  44   void SetGroupRegex(const char* regex);
  45
  46   /**
  47    * Add a file name to the explicit list of files for this group.
  48    */
  49   void AddGroupFile(const char* name);
  50
  51   /**
  52    * Add child to this sourcegroup
  53    */
  54   void AddChild(cmSourceGroup child);
  55
  56   /**
  57    * Looks up child and returns it
  58    */
  59   cmSourceGroup *lookupChild(const char *name);
  60
  61   /**
  62    * Get the name of this group.
  63    */
  64   const char* GetName() const;
  65
  66   /**
  67    * Check if the given name matches this group's regex.
  68    */
  69   bool MatchesRegex(const char* name);
  70
  71   /**
  72    * Check if the given name matches this group's explicit file list.
  73    */
  74   bool MatchesFiles(const char* name);
  75
  76   /**
  77    * Check if the given name matches this group's explicit file list
  78    * in children.
  79    */
  80   cmSourceGroup *MatchChildrenFiles(const char *name);
  81
  82   /**
  83    * Check if the given name matches this group's regex in children.
  84    */
  85   cmSourceGroup *MatchChildrenRegex(const char *name);
  86
  87   /**
  88    * Assign the given source file to this group.  Used only by
  89    * generators.
  90    */
  91   void AssignSource(const cmSourceFile* sf);
  92
  93   /**
  94    * Get the list of the source files that have been assigned to this
  95    * source group.
  96    */
  97   const std::vector<const cmSourceFile*>& GetSourceFiles() const;
  98   std::vector<const cmSourceFile*>& GetSourceFiles();
  99
 100   std::vector<cmSourceGroup> GetGroupChildren() const;
 101 private:
 102   /**
 103    * The name of the source group.
 104    */
 105   std::string Name;
 106
 107   /**
 108    * The regular expression matching the files in the group.
 109    */
 110   cmsys::RegularExpression GroupRegex;
 111
 112   /**
 113    * Set of file names explicitly added to this group.
 114    */
 115   std::set<cmStdString> GroupFiles;
 116
 117   /**
 118    * Vector of all source files that have been assigned to
 119    * this group.
 120    */
 121   std::vector<const cmSourceFile*> SourceFiles;
 122
 123   std::vector<cmSourceGroup> GroupChildren;
 124 };
 125
 126 #endif