option.cc

Go to the documentation of this file.

// -*- mode:c++;tab-width:2;indent-tabs-mode:t;show-trailing-whitespace:t;rm-trailing-spaces:t -*-
// vi: set ts=2 noet:
//
// (c) Copyright Rosetta Commons Member Institutions.
// (c) This file is part of the Rosetta software suite and is made available under license.
// (c) The Rosetta software is developed by the contributing members of the Rosetta Commons.
// (c) For more information, see http://www.rosettacommons.org. Questions about this can be
// (c) addressed to University of Washington UW TechTransfer, email: license@u.washington.edu.

/// @file   basic/options/option.cc
/// @brief  Program options global and initialization function
/// @author Stuart G. Mentzer (Stuart_Mentzer@objexx.com)


// Unit headers
#include <basic/options/option.hh>
#include <basic/options/option.cc.include.gen.hh>              // for add_al...

#include <utility/options/OptionCollection.hh>                 // for Option...

#include <basic/Tracer.hh>                                     // for Tracer
#include <basic/options/keys/carbohydrates.OptionKeys.gen.hh>  // for glycam...
#include <basic/options/keys/chemical.OptionKeys.gen.hh>       // for overri...
#include <basic/options/keys/in.OptionKeys.gen.hh>             // for altern...
#include <basic/options/keys/out.OptionKeys.gen.hh>            // for path, pdb
#include <basic/options/keys/score.OptionKeys.gen.hh>          // for no_pro...

#include <basic/options/option.cc.gen.hh>                      // for add_al...

#include <iosfwd>                                              // for string
#include <string>                                              // for allocator
#include <utility/options/BooleanOption.hh>                    // for Boolea...
#include <utility/options/PathOption.hh>                       // for PathOp...
#include <utility/options/PathVectorOption.hh>                 // for PathVe...
#include <utility/options/StringVectorOption.hh>               // for String...
#include <utility/options/VectorOption_T_.hh>                  // for Vector...
#include <utility/vector1.hh>                                  // for vector1

namespace basic {
namespace options {

static THREAD_LOCAL basic::Tracer TR( "basic.options" );

/// @details OptionCollection global
utility::options::OptionCollection option;


/// @brief Named verbosity levels
int const silent  ( 0 ); // No messages output
int const quiet   ( 1 );
int const standard( 2 );
int const inform  ( 4 );
int const chat    ( 6 );
int const yap     ( 7 );
int const gush    ( 8 );
int const verbose ( 9 ); // All messages output


/// @brief Initialize the options
OptionCollection &
initialize()
{

  using namespace utility::options;
  using namespace basic::options::OptionKeys;
  using utility::file::PathName;
#ifdef BOINC
  std::cerr << "Options::initialize()" << std::endl; std::cerr.flush();
#endif
  // Load the built-in options
  option.add_built_in_options();
#ifdef BOINC
  std::cerr << "Options::adding_options()" << std::endl; std::cerr.flush();
#endif
  // Include options generated by Python script

  add_all_rosetta_options( option );
#ifdef BOINC
  std::cerr << "Options::initialize() Check specs." << std::endl; std::cerr.flush();
#endif
  // Check for problems in the option specifications
  option.check_specs();
#ifdef BOINC
  std::cerr << "Options::initialize()  End reached" << std::endl; std::cerr.flush();
#endif

  return option;
}


/// @brief Process the specified options.
/// @note  Do more complex value setup and checks here than the option system provides.
OptionCollection &
process()
{
  using namespace utility::options;

  { // Input paths
    using namespace basic::options::OptionKeys::in::path;

    option[ fragments ].default_to( option[ path ] );
    option[ pdb ].default_to( option[ path ] );
    option[ database ].default_to( option[ path ] );
  }

  { // Output paths
    using namespace basic::options::OptionKeys::out::path;

    option[ pdb ].default_to( option[ path ] );
    option[ score ].default_to( option[ path ] );
  }

  {  // Carbohydrate-related umbrella options to make life easier for users
    using namespace basic::options::OptionKeys;

    if ( option[ in::include_sugars ] ) {
      option[ chemical::override_rsd_type_limit ].value( true );
      option[ score::no_pro_close_ring_closure ].value( true );
      //option[ score::ring_close_shadow_constraint ].value( 0.1 );
    }
    if ( option[ carbohydrates::glycam_pdb_format ] ) {
      utility::vector1< std::string > alt_codes_list;
      if ( option[ in::alternate_3_letter_codes ].active() ) {
        alt_codes_list.append( option[ in::alternate_3_letter_codes ]() );
      }
      alt_codes_list.push_back( "glycam.codes" );
      option[ in::alternate_3_letter_codes ].value( alt_codes_list );
    }
  }

  TR.flush();
  return option;
}


} // namespace options
} // namespace basic