CMake/Source/cmAbstractFilesRule.h

/*=========================================================================

  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 cmAbstractFilesRule_h
#define cmAbstractFilesRule_h

#include "cmStandardIncludes.h"
#include "cmRuleMaker.h"

class cmAbstractFilesRule : public cmRuleMaker
{
public:
  virtual cmRuleMaker* Clone() 
    {
      return new cmAbstractFilesRule;
    }

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

  /**
   * This is called at the end after all the information
   * specified by the rules is accumulated.
   */
  virtual void FinalPass() { }
  
  /**
   * The name of the rule as specified in CMakeList.txt.
   */
  virtual const char* GetName() { return "ABSTRACT_FILES";}

  /**
   * Succinct documentation.
   */
  virtual const char* TerseDocumentation() 
    {
    return "A list of abstract classes, useful for wrappers.";
    }
  
  /**
   * Longer documentation.
   */
  virtual const char* FullDocumentation()
    {
      return
        "ABSTRACT_FILES(file1 file2 ..)";
    }
};



#endif