* NEW: Mention pending breakpoint changes and

[deliverable/binutils-gdb.git] / gold / parameters.h

// parameters.h -- general parameters for a link using gold  -*- C++ -*-

// Copyright 2006, 2007 Free Software Foundation, Inc.
// Written by Ian Lance Taylor <iant@google.com>.

// This file is part of gold.

// This program 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 of the License, or
// (at your option) any later version.

// This program 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 this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
// MA 02110-1301, USA.

#ifndef GOLD_PARAMETERS_H
#define GOLD_PARAMETERS_H

namespace gold
{

class General_options;

// Here we define the Parameters class which simply holds simple
// general parameters which apply to the entire link.  We use a global
// variable for this.  This is in contrast to the General_options
// class, which holds the complete state of position independent
// command line options.  The hope is that Parameters will stay fairly
// simple, so that if this turns into a library it will be clear how
// these parameters should be set.

class Parameters
{
 public:
  Parameters(const General_options*);

  // Whether we are generating a regular executable.
  bool
  output_is_executable() const
  { return this->output_file_type_ == OUTPUT_EXECUTABLE; }

  // Whether we are generating a shared library.
  bool
  output_is_shared() const
  { return this->output_file_type_ == OUTPUT_SHARED; }

  // Whether we are generating an object file.
  bool
  output_is_object() const
  { return this->output_file_type_ == OUTPUT_OBJECT; }

  // The size of the output file we are generating.  This should
  // return 32 or 64.
  int
  get_size() const
  {
    gold_assert(this->is_size_and_endian_valid_);
    return this->size_;
  }

  // Whether the output is big endian.
  bool
  is_big_endian() const
  {
    gold_assert(this->is_size_and_endian_valid_);
    return this->is_big_endian_;
  }

  // The general linker optimization level.
  int
  optimization_level() const
  { return this->optimization_level_; }

  // Set the size and endianness.
  void
  set_size_and_endianness(int size, bool is_big_endian);

 private:
  // The types of output files.
  enum Output_file_type
    {
      // Generating executable.
      OUTPUT_EXECUTABLE,
      // Generating shared library.
      OUTPUT_SHARED,
      // Generating object file.
      OUTPUT_OBJECT
    };

  // The type of the output file.
  Output_file_type output_file_type_;
  // Whether the size_ and is_big_endian_ fields are valid.
  bool is_size_and_endian_valid_;
  // The size of the output file--32 or 64.
  int size_;
  // Whether the output file is big endian.
  bool is_big_endian_;
  // The optimization level.
  int optimization_level_;
};

// This is a global variable.
extern const Parameters* parameters;

// Initialize the global variable.
extern void initialize_parameters(const General_options*);

// Set the size and endianness of the global parameters variable.
extern void set_parameters_size_and_endianness(int size, bool is_big_endian);

} // End namespace gold.

#endif // !defined(GOLD_PARAMATERS_H)