constants.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2006,2009,2013 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * GNU Radio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 *
 * GNU Radio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef INCLUDED_GR_CONSTANTS_H
#define INCLUDED_GR_CONSTANTS_H

#include <gnuradio/api.h>
#include <string>

namespace gr {

  /*!
   * \brief return SYSCONFDIR. Typically ${CMAKE_INSTALL_PREFIX}/etc or /etc
   */
  GR_RUNTIME_API const std::string prefix();

  /*!
   * \brief return SYSCONFDIR. Typically ${CMAKE_INSTALL_PREFIX}/etc or /etc
   */
  GR_RUNTIME_API const std::string sysconfdir();

  /*!
   * \brief return preferences file directory. Typically ${SYSCONFDIR}/etc/conf.d
   */
  GR_RUNTIME_API const std::string prefsdir();

  /*!
   * \brief return date/time of build, as set when 'cmake' is run
   */
  GR_RUNTIME_API const std::string build_date();

  /*!
   * \brief return version string defined by cmake (GrVersion.cmake)
   */
  GR_RUNTIME_API const std::string version();

  /*!
   * \brief return just the major version defined by cmake
   */
  GR_RUNTIME_API const std::string major_version();

  /*!
   * \brief return just the api version defined by cmake
   */
  GR_RUNTIME_API const std::string api_version();

  /*!
   * \brief returnjust the minor version defined by cmake
   */
  GR_RUNTIME_API const std::string minor_version();

  /*!
   * \brief return C compiler used to build this version of GNU Radio
   */
  GR_RUNTIME_API const std::string c_compiler();

  /*!
   * \brief return C++ compiler used to build this version of GNU Radio
   */
  GR_RUNTIME_API const std::string cxx_compiler();

  /*!
   * \brief return C and C++ compiler flags used to build this version of GNU Radio
   */
  GR_RUNTIME_API const std::string  compiler_flags();

  /*!
   * \brief return build-time enabled components
   */
  GR_RUNTIME_API const std::string  build_time_enabled_components();

} /* namespace gr */

#endif /* INCLUDED_GR_CONSTANTS_H */