1/*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ART_RUNTIME_OFFSETS_H_
18#define ART_RUNTIME_OFFSETS_H_
19
20#include <iostream>  // NOLINT
21#include "globals.h"
22
23namespace art {
24
25// Allow the meaning of offsets to be strongly typed.
26class Offset {
27 public:
28  explicit Offset(size_t val) : val_(val) {}
29  int32_t Int32Value() const {
30    return static_cast<int32_t>(val_);
31  }
32  uint32_t Uint32Value() const {
33    return static_cast<uint32_t>(val_);
34  }
35  size_t SizeValue() const {
36    return val_;
37  }
38
39 protected:
40  size_t val_;
41};
42std::ostream& operator<<(std::ostream& os, const Offset& offs);
43
44// Offsets relative to the current frame.
45class FrameOffset : public Offset {
46 public:
47  explicit FrameOffset(size_t val) : Offset(val) {}
48  bool operator>(FrameOffset other) const { return val_ > other.val_; }
49  bool operator<(FrameOffset other) const { return val_ < other.val_; }
50};
51
52// Offsets relative to the current running thread.
53template<size_t pointer_size>
54class ThreadOffset : public Offset {
55 public:
56  explicit ThreadOffset(size_t val) : Offset(val) {}
57};
58
59// Offsets relative to an object.
60class MemberOffset : public Offset {
61 public:
62  explicit MemberOffset(size_t val) : Offset(val) {}
63};
64
65}  // namespace art
66
67#endif  // ART_RUNTIME_OFFSETS_H_
68