DegateHelper.h

Go to the documentation of this file.

/* -*-c++-*-

  This file is part of the IC reverse engineering tool degate.

  Copyright 2008, 2009, 2010 by Martin Schobert

  Degate 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
  any later version.

  Degate 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 degate. If not, see <http://www.gnu.org/licenses/>.

*/

#ifndef __DEGATEHELPER_H__
#define __DEGATEHELPER_H__


#define LENGTH_TO_MAX(l) (l > 0 ? l - 1 : 0)

namespace degate {

  /**
   * Calculate the next higher power of two for a value \p i with i > 0.
   */
  template<typename IntegerType>
  IntegerType next_power_of_two(IntegerType i) {
    IntegerType rval = 1;
    while(rval < i) rval <<= 1;
    return rval;
  }

  /**
   * Tokenize a string.
   * @param str That is the string to tokenize, e.g.
   *    "hello world. \"foo bar\"". This would result
   *    in three tokens.
   */
  std::vector<std::string> tokenize(std::string const& str);

  /**
   * Write a string to a temp file.
   * @param dir The directory, where the temp file should be created.
   * @param content The file content.
   * @return Returns the temp file name including the directory part.
   */
  std::string write_string_to_temp_file(std::string const& dir,
                                        std::string const& content);

  /**
   * Write a string to a file.
   * @param path Path to file.
   * @param content The file content.
   */
  void write_string_to_file(std::string const& path,
                            std::string const& content);


  /**
   * Execute a command.
   * @param command The command to execute.
   * @param params list of parameters.
   * @returns Returns the exit code.
   */
  int execute_command(std::string const& command, std::list<std::string> const& params);
}

#endif