LatinIME/native/jni/src/proximity_info.h

/*
 * Copyright (C) 2011 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_PROXIMITY_INFO_H
#define LATINIME_PROXIMITY_INFO_H

#include "defines.h"
#include "hash_map_compat.h"
#include "jni.h"
#include "proximity_info_utils.h"

namespace latinime {

class Correction;

class ProximityInfo {
 public:
    ProximityInfo(JNIEnv *env, const jstring localeJStr,
            const int keyboardWidth, const int keyboardHeight, const int gridWidth,
            const int gridHeight, const int mostCommonKeyWidth, const jintArray proximityChars,
            const int keyCount, const jintArray keyXCoordinates, const jintArray keyYCoordinates,
            const jintArray keyWidths, const jintArray keyHeights, const jintArray keyCharCodes,
            const jfloatArray sweetSpotCenterXs, const jfloatArray sweetSpotCenterYs,
            const jfloatArray sweetSpotRadii);
    ~ProximityInfo();
    bool hasSpaceProximity(const int x, const int y) const;
    int getNormalizedSquaredDistance(const int inputIndex, const int proximityIndex) const;
    float getNormalizedSquaredDistanceFromCenterFloatG(
            const int keyId, const int x, const int y,
            const float verticalScale) const;
    bool sameAsTyped(const unsigned short *word, int length) const;
    int getCodePointOf(const int keyIndex) const;
    bool hasSweetSpotData(const int keyIndex) const {
        // When there are no calibration data for a key,
        // the radius of the key is assigned to zero.
        return mSweetSpotRadii[keyIndex] > 0.0f;
    }
    float getSweetSpotRadiiAt(int keyIndex) const { return mSweetSpotRadii[keyIndex]; }
    float getSweetSpotCenterXAt(int keyIndex) const { return mSweetSpotCenterXs[keyIndex]; }
    float getSweetSpotCenterYAt(int keyIndex) const { return mSweetSpotCenterYs[keyIndex]; }
    void calculateNearbyKeyCodes(
            const int x, const int y, const int primaryKey, int *inputCodes) const;
    bool hasTouchPositionCorrectionData() const { return HAS_TOUCH_POSITION_CORRECTION_DATA; }
    int getMostCommonKeyWidth() const { return MOST_COMMON_KEY_WIDTH; }
    int getMostCommonKeyWidthSquare() const { return MOST_COMMON_KEY_WIDTH_SQUARE; }
    int getKeyCount() const { return KEY_COUNT; }
    int getCellHeight() const { return CELL_HEIGHT; }
    int getCellWidth() const { return CELL_WIDTH; }
    int getGridWidth() const { return GRID_WIDTH; }
    int getGridHeight() const { return GRID_HEIGHT; }
    int getKeyboardWidth() const { return KEYBOARD_WIDTH; }
    int getKeyboardHeight() const { return KEYBOARD_HEIGHT; }
    float getKeyboardHypotenuse() const { return KEYBOARD_HYPOTENUSE; }

    int getKeyCenterXOfCodePointG(int charCode) const;
    int getKeyCenterYOfCodePointG(int charCode) const;
    int getKeyCenterXOfKeyIdG(int keyId) const;
    int getKeyCenterYOfKeyIdG(int keyId) const;
    int getKeyKeyDistanceG(int keyId0, int keyId1) const;

    AK_FORCE_INLINE void initializeProximities(const int *const inputCodes,
            const int *const inputXCoordinates, const int *const inputYCoordinates,
            const int inputSize, int *allInputCodes) const {
        ProximityInfoUtils::initializeProximities(inputCodes, inputXCoordinates, inputYCoordinates,
                inputSize, mKeyXCoordinates, mKeyYCoordinates, mKeyWidths, mKeyHeights,
                mProximityCharsArray, CELL_HEIGHT, CELL_WIDTH, GRID_WIDTH, MOST_COMMON_KEY_WIDTH,
                KEY_COUNT, mLocaleStr, &mCodeToKeyMap, allInputCodes);
    }

    AK_FORCE_INLINE int getKeyIndexOf(const int c) const {
        return ProximityInfoUtils::getKeyIndexOf(KEY_COUNT, c, &mCodeToKeyMap);
    }

    AK_FORCE_INLINE bool isCodePointOnKeyboard(const int codePoint) const {
        return getKeyIndexOf(codePoint) != NOT_AN_INDEX;
    }

 private:
    DISALLOW_IMPLICIT_CONSTRUCTORS(ProximityInfo);

    void initializeG();
    float calculateNormalizedSquaredDistance(const int keyIndex, const int inputIndex) const;
    bool hasInputCoordinates() const;

    const int GRID_WIDTH;
    const int GRID_HEIGHT;
    const int MOST_COMMON_KEY_WIDTH;
    const int MOST_COMMON_KEY_WIDTH_SQUARE;
    const int CELL_WIDTH;
    const int CELL_HEIGHT;
    const int KEY_COUNT;
    const int KEYBOARD_WIDTH;
    const int KEYBOARD_HEIGHT;
    const float KEYBOARD_HYPOTENUSE;
    const bool HAS_TOUCH_POSITION_CORRECTION_DATA;
    char mLocaleStr[MAX_LOCALE_STRING_LENGTH];
    int *mProximityCharsArray;
    int mKeyXCoordinates[MAX_KEY_COUNT_IN_A_KEYBOARD];
    int mKeyYCoordinates[MAX_KEY_COUNT_IN_A_KEYBOARD];
    int mKeyWidths[MAX_KEY_COUNT_IN_A_KEYBOARD];
    int mKeyHeights[MAX_KEY_COUNT_IN_A_KEYBOARD];
    int mKeyCodePoints[MAX_KEY_COUNT_IN_A_KEYBOARD];
    float mSweetSpotCenterXs[MAX_KEY_COUNT_IN_A_KEYBOARD];
    float mSweetSpotCenterYs[MAX_KEY_COUNT_IN_A_KEYBOARD];
    float mSweetSpotRadii[MAX_KEY_COUNT_IN_A_KEYBOARD];
    hash_map_compat<int, int> mCodeToKeyMap;

    int mKeyIndexToCodePointG[MAX_KEY_COUNT_IN_A_KEYBOARD];
    int mCenterXsG[MAX_KEY_COUNT_IN_A_KEYBOARD];
    int mCenterYsG[MAX_KEY_COUNT_IN_A_KEYBOARD];
    int mKeyKeyDistancesG[MAX_KEY_COUNT_IN_A_KEYBOARD][MAX_KEY_COUNT_IN_A_KEYBOARD];
    // TODO: move to correction.h
};
} // namespace latinime
#endif // LATINIME_PROXIMITY_INFO_H