fixed_error_stack.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2014-2015, Hewlett-Packard Development Company, LP.
 * 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 2 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * HP designates this particular file as subject to the "Classpath" exception
 * as provided by HP in the LICENSE.txt file that accompanied this code.
 */
#ifndef FOEDUS_FIXED_ERROR_STACK_HPP_
#define FOEDUS_FIXED_ERROR_STACK_HPP_

#include <stdint.h>

#include <iosfwd>

#include "foedus/assert_nd.hpp"
#include "foedus/cxx11.hpp"
#include "foedus/error_stack.hpp"
#include "foedus/assorted/fixed_string.hpp"

namespace foedus {

class FixedErrorStack {
 public:
  typedef assorted::FixedString<124> FixedFileName;
  typedef assorted::FixedString<124> FixedFuncName;
  typedef assorted::FixedString<508> FixedErrorMessage;

  FixedErrorStack() : os_errno_(0), error_code_(kErrorCodeOk), stack_depth_(0) {}
  explicit FixedErrorStack(const ErrorStack& src) { operator=(src); }

  FixedErrorStack& operator=(const ErrorStack &src);

  bool                is_error() const { return error_code_ != kErrorCodeOk; }

  ErrorCode           get_error_code() const { return error_code_; }

  const char*         get_message() const { return get_error_message(error_code_); }

  const FixedErrorMessage& get_custom_message() const { return custom_message_; }

  uint16_t            get_stack_depth() const { return stack_depth_; }

  uint32_t            get_linenum(uint16_t stack_index) const {
    ASSERT_ND(stack_index < stack_depth_);
    return linenums_[stack_index];
  }

  const FixedFileName& get_filename(uint16_t stack_index) const {
    ASSERT_ND(stack_index < stack_depth_);
    return filenames_[stack_index];
  }

  const FixedFuncName& get_func(uint16_t stack_index) const {
    ASSERT_ND(stack_index < stack_depth_);
    return funcs_[stack_index];
  }

  void                output(std::ostream* ptr) const;

  void                clear() { error_code_ = kErrorCodeOk; }

  ErrorStack          to_error_stack() const;

  void                from_error_stack(const ErrorStack& other);

  friend std::ostream& operator<<(std::ostream& o, const FixedErrorStack& obj);

 private:
  FixedFileName   filenames_[ErrorStack::kMaxStackDepth];

  FixedFuncName   funcs_[ErrorStack::kMaxStackDepth];

  uint32_t        linenums_[ErrorStack::kMaxStackDepth];

  FixedErrorMessage custom_message_;

  int             os_errno_;

  ErrorCode       error_code_;

  uint16_t        stack_depth_;
};

}  // namespace foedus
#endif  // FOEDUS_FIXED_ERROR_STACK_HPP_