Home | History | Annotate | Download | only in utils
      1 /*
      2  * Copyright (C) 2014 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 LATINIME_BYTE_ARRAY_VIEW_H
     18 #define LATINIME_BYTE_ARRAY_VIEW_H
     19 
     20 #include <cstdint>
     21 #include <cstdlib>
     22 
     23 #include "defines.h"
     24 
     25 namespace latinime {
     26 
     27 /**
     28  * Helper class used to keep track of read accesses for a given memory region.
     29  */
     30 class ReadOnlyByteArrayView {
     31  public:
     32     ReadOnlyByteArrayView() : mPtr(nullptr), mSize(0) {}
     33 
     34     ReadOnlyByteArrayView(const uint8_t *const ptr, const size_t size)
     35             : mPtr(ptr), mSize(size) {}
     36 
     37     AK_FORCE_INLINE size_t size() const {
     38         return mSize;
     39     }
     40 
     41     AK_FORCE_INLINE const uint8_t *data() const {
     42         return mPtr;
     43     }
     44 
     45  private:
     46     DISALLOW_ASSIGNMENT_OPERATOR(ReadOnlyByteArrayView);
     47 
     48     const uint8_t *const mPtr;
     49     const size_t mSize;
     50 };
     51 
     52 /**
     53  * Helper class used to keep track of read-write accesses for a given memory region.
     54  */
     55 class ReadWriteByteArrayView {
     56  public:
     57     ReadWriteByteArrayView() : mPtr(nullptr), mSize(0) {}
     58 
     59     ReadWriteByteArrayView(uint8_t *const ptr, const size_t size)
     60             : mPtr(ptr), mSize(size) {}
     61 
     62     AK_FORCE_INLINE size_t size() const {
     63         return mSize;
     64     }
     65 
     66     AK_FORCE_INLINE uint8_t *data() const {
     67         return mPtr;
     68     }
     69 
     70     AK_FORCE_INLINE ReadOnlyByteArrayView getReadOnlyView() const {
     71         return ReadOnlyByteArrayView(mPtr, mSize);
     72     }
     73 
     74     ReadWriteByteArrayView subView(const size_t start, const size_t n) const {
     75         ASSERT(start + n <= mSize);
     76         return ReadWriteByteArrayView(mPtr + start, n);
     77     }
     78 
     79  private:
     80     DISALLOW_ASSIGNMENT_OPERATOR(ReadWriteByteArrayView);
     81 
     82     uint8_t *const mPtr;
     83     const size_t mSize;
     84 };
     85 
     86 } // namespace latinime
     87 #endif // LATINIME_BYTE_ARRAY_VIEW_H
     88