xref: /packages/inputmethods/LatinIME/native/jni/src/suggest/core/suggest_options.h

/*
 * Copyright (C) 2013 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef LATINIME_SUGGEST_OPTIONS_H
#define LATINIME_SUGGEST_OPTIONS_H

#include "defines.h"

namespace latinime {

class SuggestOptions{
 public:
    SuggestOptions(const int *const options, const int length)
            : mOptions(options), mLength(length) {}

    AK_FORCE_INLINE bool isGesture() const {
        return getBoolOption(IS_GESTURE);
    }

    AK_FORCE_INLINE bool useFullEditDistance() const {
        return getBoolOption(USE_FULL_EDIT_DISTANCE);
    }

    AK_FORCE_INLINE bool blockOffensiveWords() const {
        return getBoolOption(BLOCK_OFFENSIVE_WORDS);
    }

    AK_FORCE_INLINE bool enableSpaceAwareGesture() const {
        return getBoolOption(SPACE_AWARE_GESTURE_ENABLED);
    }

    AK_FORCE_INLINE bool getAdditionalFeaturesBoolOption(const int key) const {
        return getBoolOption(key + ADDITIONAL_FEATURES_OPTIONS);
    }

 private:
    DISALLOW_IMPLICIT_CONSTRUCTORS(SuggestOptions);

    // Need to update com.android.inputmethod.latin.NativeSuggestOptions when you add, remove or
    // reorder options.
    static const int IS_GESTURE = 0;
    static const int USE_FULL_EDIT_DISTANCE = 1;
    static const int BLOCK_OFFENSIVE_WORDS = 2;
    static const int SPACE_AWARE_GESTURE_ENABLED = 3;
    // Additional features options are stored after the other options and used as setting values of
    // experimental features.
    static const int ADDITIONAL_FEATURES_OPTIONS = 4;

    const int *const mOptions;
    const int mLength;

    AK_FORCE_INLINE bool isValidKey(const int key) const {
        return 0 <= key && key < mLength;
    }

    AK_FORCE_INLINE bool getBoolOption(const int key) const {
        if (isValidKey(key)) {
            return mOptions[key] != 0;
        }
        return false;
    }

    AK_FORCE_INLINE int getIntOption(const int key) const {
        if (isValidKey(key)) {
            return mOptions[key];
        }
        return 0;
    }
};
} // namespace latinime
#endif // LATINIME_SUGGEST_OPTIONS_H