CMake/Source/CTest/cmCTestSubmitCommand.h

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

  Program:   CMake - Cross-Platform Makefile Generator
  Module:    $RCSfile$
  Language:  C++
  Date:      $Date$
  Version:   $Revision$

  Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef cmCTestSubmitCommand_h
#define cmCTestSubmitCommand_h

#include "cmCTestHandlerCommand.h"
#include "cmCTest.h"

/** \class cmCTestSubmit
 * \brief Run a ctest script
 *
 * cmCTestSubmitCommand defineds the command to submit the test results for
 * the project.
 */
class cmCTestSubmitCommand : public cmCTestHandlerCommand
{
public:

  cmCTestSubmitCommand()
    {
    this->PartsMentioned = false;
    this->FilesMentioned = false;
    }

  /**
   * This is a virtual constructor for the command.
   */
  virtual cmCommand* Clone()
    {
    cmCTestSubmitCommand* ni = new cmCTestSubmitCommand;
    ni->CTest = this->CTest;
    ni->CTestScriptHandler = this->CTestScriptHandler;
    return ni;
    }

  /**
   * The name of the command as specified in CMakeList.txt.
   */
  virtual const char* GetName() { return "ctest_submit";}

  /**
   * Succinct documentation.
   */
  virtual const char* GetTerseDocumentation()
    {
    return "Submit results to a dashboard server.";
    }

  /**
   * More documentation.
   */
  virtual const char* GetFullDocumentation()
    {
    return
      "  ctest_submit([PARTS ...] [FILES ...] [RETURN_VALUE res])\n"
      "By default all available parts are submitted if no PARTS or FILES "
      "are specified.  "
      "The PARTS option lists a subset of parts to be submitted.  "
      "Valid part names are:\n"
      "  Start      = nothing\n"
      "  Update     = ctest_update results, in Update.xml\n"
      "  Configure  = ctest_configure results, in Configure.xml\n"
      "  Build      = ctest_build results, in Build.xml\n"
      "  Test       = ctest_test results, in Test.xml\n"
      "  Coverage   = ctest_coverage results, in Coverage.xml\n"
      "  MemCheck   = ctest_memcheck results, in DynamicAnalysis.xml\n"
      "  Notes      = Files listed by CTEST_NOTES_FILES, in Notes.xml\n"
      "  ExtraFiles = Files listed by CTEST_EXTRA_SUBMIT_FILES\n"
      "  Submit     = nothing\n"
      "The FILES option explicitly lists specific files to be submitted.  "
      "Each individual file must exist at the time of the call.\n";
    }

  cmTypeMacro(cmCTestSubmitCommand, cmCTestHandlerCommand);

protected:
  cmCTestGenericHandler* InitializeHandler();

  virtual bool CheckArgumentKeyword(std::string const& arg);
  virtual bool CheckArgumentValue(std::string const& arg);

  enum
  {
    ArgumentDoingParts = Superclass::ArgumentDoingLast1,
    ArgumentDoingFiles,
    ArgumentDoingLast2
  };

  bool PartsMentioned;
  std::set<cmCTest::Part> Parts;
  bool FilesMentioned;
  cmCTest::SetOfStrings Files;
};


#endif