ExternalAnyKeyboard.java - This Java code is part of a keyb…

/tags/20100328/src/com/menny/android/anysoftkeyboard/keyboards/ExternalAnyKeyboard.java

http://softkeyboard.googlecode.com/ · Java · 322 lines · 286 code · 25 blank · 11 comment · 57 complexity · 4b17df227860deeda2412ed017dfd087 MD5 · raw file


package com.menny.android.anysoftkeyboard.keyboards;



import org.xmlpull.v1.XmlPullParser;



import android.content.Context;

import android.content.res.Configuration;

import android.content.res.Resources;

import android.util.AttributeSet;

import android.util.Log;

import android.util.Xml;



import com.menny.android.anysoftkeyboard.AnyKeyboardContextProvider;

import com.menny.android.anysoftkeyboard.AnySoftKeyboardConfiguration;

import com.menny.android.anysoftkeyboard.R;

import com.menny.android.anysoftkeyboard.keyboards.AnyKeyboard.HardKeyboardTranslator;



public class ExternalAnyKeyboard extends AnyKeyboard implements HardKeyboardTranslator {



	private static final String XML_TRANSLATION_TAG = "PhysicalTranslation";

	private static final String XML_QWERTY_ATTRIBUTE = "QwertyTranslation";

	private static final String XML_SEQUENCE_TAG = "SequenceMapping";

	private static final String XML_KEYS_ATTRIBUTE = "keySequence";

	private static final String XML_ALT_ATTRIBUTE = "altModifier";

	private static final String XML_SHIFT_ATTRIBUTE = "shiftModifier";

	private static final String XML_TARGET_ATTRIBUTE = "targetChar";

	private static final String XML_TARGET_CHAR_CODE_ATTRIBUTE = "targetCharCode";

	private final String mPrefId;

	private final int mNameResId;

	private final int mIconId;

	private final String mDefaultDictionary;

	private final HardKeyboardSequenceHandler mHardKeyboardTranslator;

	private final String mAdditionalIsLetterExceptions;

	

	protected ExternalAnyKeyboard(AnyKeyboardContextProvider askContext, Context context,

			int xmlLayoutResId,

			int xmlLandscapeResId,

			String prefId,

			int nameResId,

			int iconResId,

			int qwertyTranslationId,

			String defaultDictionary,

			String additionalIsLetterExceptions) {

		super(askContext, context, getKeyboardId(context, xmlLayoutResId, xmlLandscapeResId));

		mPrefId = prefId;

		mNameResId = nameResId;

		mIconId = iconResId;

		mDefaultDictionary = defaultDictionary;

		if (qwertyTranslationId != -1)

		{

			mHardKeyboardTranslator = createPhysicalTranslatorFromResourceId(context.getApplicationContext(), qwertyTranslationId);

		}

		else

		{

			mHardKeyboardTranslator = null;

		}

		

		mAdditionalIsLetterExceptions = additionalIsLetterExceptions;

		

		for(final Key key : getKeys())

		{

		    final Resources localResources = getASKContext().getApplicationContext().getResources();

	        //adding icons

	        switch(key.codes[0])

	        {

	        case AnyKeyboard.KEYCODE_DELETE:

	            key.icon = localResources.getDrawable(R.drawable.sym_keyboard_delete_small);

	            break;

	        case AnyKeyboard.KEYCODE_SHIFT:

	            key.icon = localResources.getDrawable(R.drawable.sym_keyboard_shift);

	            break;

	        case AnyKeyboard.KEYCODE_CTRL:

	            key.icon = localResources.getDrawable(R.drawable.sym_keyboard_ctrl);

	            break;

	        case 32://SPACE

	            key.icon = localResources.getDrawable(R.drawable.sym_keyboard_space);

	            break;

	        case 9://TAB

	            key.icon = localResources.getDrawable(R.drawable.tab_key);

	            break;

	//these two will be set upon calling setTextVariation           

//	      case AnyKeyboard.KEYCODE_SMILEY:

//	          key.icon = res.getDrawable(R.drawable.sym_keyboard_smiley);

//	          key.popupResId = R.xml.popup_smileys;

//	          break;

//	      case 10://ENTER

//	          key.icon = res.getDrawable(R.drawable.sym_keyboard_return);

//	          break;

	        }

		}

	}



	private HardKeyboardSequenceHandler createPhysicalTranslatorFromResourceId(Context context, int qwertyTranslationId) {

		HardKeyboardSequenceHandler translator = new HardKeyboardSequenceHandler();

		XmlPullParser parser = context.getResources().getXml(qwertyTranslationId);

		final String TAG = "ASK Hard Translation Parser";

		try {

            int event;

            boolean inTranslations = false;

            while ((event = parser.next()) != XmlPullParser.END_DOCUMENT) 

            {

            	String tag = parser.getName();

                if (event == XmlPullParser.START_TAG) {

                    if (XML_TRANSLATION_TAG.equals(tag)) {

                    	inTranslations = true;

                    	AttributeSet attrs = Xml.asAttributeSet(parser);

                    	final String qwerty = attrs.getAttributeValue(null, XML_QWERTY_ATTRIBUTE);

                    	translator.addQwertyTranslation(qwerty);

                    	if (AnySoftKeyboardConfiguration.getInstance().getDEBUG()) Log.d(TAG, "Starting parsing "+XML_TRANSLATION_TAG+". Qwerty:"+qwerty);

                    }

                    else if (inTranslations && XML_SEQUENCE_TAG.equals(tag))

                    {

                    	if (AnySoftKeyboardConfiguration.getInstance().getDEBUG()) Log.d(TAG, "Starting parsing "+XML_SEQUENCE_TAG);

                    	AttributeSet attrs = Xml.asAttributeSet(parser);

                    	

                    	final int[] keyCodes = getKeyCodesFromPhysicalSequence(attrs.getAttributeValue(null, XML_KEYS_ATTRIBUTE));

                    	final boolean isAlt = attrs.getAttributeBooleanValue(null, XML_ALT_ATTRIBUTE, false);

                    	final boolean isShift = attrs.getAttributeBooleanValue(null, XML_SHIFT_ATTRIBUTE, false);

                    	final String targetChar = attrs.getAttributeValue(null, XML_TARGET_ATTRIBUTE);

                    	final String targetCharCode = attrs.getAttributeValue(null, XML_TARGET_CHAR_CODE_ATTRIBUTE);

                        final String target;

                        if (targetChar == null)

                        	target = Character.toString((char)Integer.parseInt(targetCharCode));

                        else

                        	target = targetChar;

                    	//asserting

                        if ((keyCodes == null) || (keyCodes.length == 0) || (target == null))

                        {

                            Log.e(TAG, "Physical translator sequence does not include mandatory fields "+XML_KEYS_ATTRIBUTE+" or "+XML_TARGET_ATTRIBUTE);

                        }

                        else

                        {

                        	if (!isAlt && !isShift)

                        	{

	                        	if (AnySoftKeyboardConfiguration.getInstance().getDEBUG()) Log.d(TAG, "Physical translation details: keys:"+printInts(keyCodes)+" target:"+target);

	                        	translator.addSequence(keyCodes, target.charAt(0));

                        	}

                        	else if (isAlt)

                        	{

                        		final int keyCode = keyCodes[0];

                        		if (AnySoftKeyboardConfiguration.getInstance().getDEBUG()) Log.d(TAG, "Physical translation details: ALT+key:"+keyCode+" target:"+target);

	                        	translator.addAltMapping(keyCode, target.charAt(0));

                        	}

                        	else if (isShift)

                        	{

                        		final int keyCode = keyCodes[0];

                        		if (AnySoftKeyboardConfiguration.getInstance().getDEBUG()) Log.d(TAG, "Physical translation details: ALT+key:"+keyCode+" target:"+target);

	                        	translator.addShiftMapping(keyCode, target.charAt(0));

                        	}

                        }                        

                    }

                }

                else if (event == XmlPullParser.END_TAG) {

                	if (XML_TRANSLATION_TAG.equals(tag)) {

                    	inTranslations = false;

                    	if (AnySoftKeyboardConfiguration.getInstance().getDEBUG()) Log.d(TAG, "Finished parsing "+XML_TRANSLATION_TAG);

                    	break;

                    } 

                	else if (inTranslations && XML_SEQUENCE_TAG.equals(tag))

                    {

                		if (AnySoftKeyboardConfiguration.getInstance().getDEBUG()) Log.d(TAG, "Finished parsing "+XML_SEQUENCE_TAG);

                    }

                }

            }

        } catch (Exception e) {

            Log.e(TAG, "Parse error:" + e);

            e.printStackTrace();

        }

		return translator;

	}



	private String printInts(int[] keyCodes) {

		String r = "";

		for(int code : keyCodes)

			r += (Integer.toString(code)+",");

		

		return r;

	}



	private int[] getKeyCodesFromPhysicalSequence(String keyCodesArray) {

		String[] splitted = keyCodesArray.split(",");

		int[] keyCodes = new int[splitted.length];

		for(int i=0;i<keyCodes.length;i++)

		{

			keyCodes[i] = Integer.parseInt(splitted[i]);

		}

		

		return keyCodes;

	}



	@Override

	public String getDefaultDictionaryLanguage() {

		return mDefaultDictionary;

	}

	

	@Override

	public String getKeyboardPrefId() {

		return mPrefId;

	}

	

	@Override

	public int getKeyboardIconResId() {

		return mIconId;

	}

	

	@Override

	public int getKeyboardNameResId() {

		return mNameResId;

	}

	

	private static int getKeyboardId(Context context, int portraitId, int landscapeId) 

	{

		final boolean inPortraitMode = 

			(context.getResources().getConfiguration().orientation == Configuration.ORIENTATION_PORTRAIT);

		

		if (inPortraitMode)

			return portraitId;

		else

			return landscapeId;

	}

	

	//this class implements the HardKeyboardTranslator interface in an empty way, the physical keyboard is Latin...

	public void translatePhysicalCharacter(HardKeyboardAction action) 

	{

		if (mHardKeyboardTranslator != null)

		{

			final char translated;

			if (action.isAltActive())

				translated = mHardKeyboardTranslator.getAltCharacter(action.getKeyCode());

			else if (action.isShiftActive())

				translated = mHardKeyboardTranslator.getShiftCharacter(action.getKeyCode());

			else

				translated = mHardKeyboardTranslator.getSequenceCharacter(action.getKeyCode(), getASKContext());

			

			if (translated != 0)

				action.setNewKeyCode(translated);

		}

	}

	

	@Override

	public boolean isLetter(char keyValue) {

		if (mAdditionalIsLetterExceptions == null)

			return super.isLetter(keyValue);

		else

			return super.isLetter(keyValue) || 

				(mAdditionalIsLetterExceptions.indexOf(keyValue) >= 0);

	}

	

	protected void setPopupKeyChars(Key aKey)

	{

		if (aKey.popupResId > 0)

			return;//if the keyboard XML already specified the popup, then no need to override

		

		if ((aKey.codes != null) && (aKey.codes.length > 0))

        {

			switch((char)aKey.codes[0])

			{

				case 'a':

					aKey.popupCharacters = "\u00e0\u00e1\u00e2\u00e3\u00e4\u00e5\u00e6\u0105";

					aKey.popupResId = com.menny.android.anysoftkeyboard.R.xml.popup;

					break;

				case 'c':

					aKey.popupCharacters = "\u00e7\u0107\u0109\u010d";

					aKey.popupResId = com.menny.android.anysoftkeyboard.R.xml.popup;

					break;

				case 'd':

					aKey.popupCharacters = "\u0111";

					aKey.popupResId = com.menny.android.anysoftkeyboard.R.xml.popup;

					break;

				case 'e':

					aKey.popupCharacters = "\u00e8\u00e9\u00ea\u00eb\u0119\u20ac";

					aKey.popupResId = com.menny.android.anysoftkeyboard.R.xml.popup;

					break;

				case 'g':

					aKey.popupCharacters = "\u011d";

					aKey.popupResId = com.menny.android.anysoftkeyboard.R.xml.popup;

					break;

				case 'h':

					aKey.popupCharacters = "\u0125";

					aKey.popupResId = com.menny.android.anysoftkeyboard.R.xml.popup;

					break;

				case 'i':

					aKey.popupCharacters = "\u00ec\u00ed\u00ee\u00ef\u0142";

					aKey.popupResId = com.menny.android.anysoftkeyboard.R.xml.popup;

					break;

				case 'j':

					aKey.popupCharacters = "\u0135";

					aKey.popupResId = com.menny.android.anysoftkeyboard.R.xml.popup;

					break;

				case 'l':

					aKey.popupCharacters = "\u0142";

					aKey.popupResId = com.menny.android.anysoftkeyboard.R.xml.popup;

					break;

				case 'o':

					aKey.popupCharacters = "\u00f2\u00f3\u00f4\u00f5\u00f6\u00f8\u0151\u0153";

					aKey.popupResId = com.menny.android.anysoftkeyboard.R.xml.popup;

					break;

				case 's':

					aKey.popupCharacters = "\u00a7\u00df\u015b\u015d\u0161";

					aKey.popupResId = com.menny.android.anysoftkeyboard.R.xml.popup;

					break;

				case 'u':

					aKey.popupCharacters = "\u00f9\u00fa\u00fb\u00fc\u016d\u0171";

					aKey.popupResId = com.menny.android.anysoftkeyboard.R.xml.popup;

					break;

				case 'n':

					aKey.popupCharacters = "\u00f1";

					aKey.popupResId = com.menny.android.anysoftkeyboard.R.xml.popup;

					break;

				case 'y':

					aKey.popupCharacters = "\u00fd\u00ff";

					aKey.popupResId = com.menny.android.anysoftkeyboard.R.xml.popup;

					break;

				case 'z':

					aKey.popupCharacters = "\u017c\u017e";

					aKey.popupResId = com.menny.android.anysoftkeyboard.R.xml.popup;

					break;

				default:

					super.setPopupKeyChars(aKey);

			}

        }

	}

}

Summary ✨

This Java code is part of a keyboard application, specifically an Android app. It processes keyboard input and translates characters into their corresponding Latin equivalents for a physical keyboard layout. The code uses XML files to define popup characters for certain keys and handles special cases like letter exceptions and additional keyboard layouts.

Alerts (7)

'case' Maintainability Info: Avoid using unnamed 'magic' numbers directly in comparisons or assignments. Use named constants (static final variables) instead to improve readability and maintainability.
74 77
'Set' Raw collection type used. Specify generic type arguments (e.g., List<String>, Map<Integer, Client>) for type safety and clarity. Avoid raw types unless interacting with legacy code.
105 113
Complexity hotspot; line 126 (total complexity: 6)
126
'catch (Exception' Catching generic 'Exception' can hide specific runtime issues. Catch more specific exception types whenever possible. Ensure caught exceptions are logged or handled appropriately, not just swallowed.
164
'.printStackTrace()' Avoid printing stack traces directly to std err/out. Use a proper logging framework to handle exceptions consistently and direct output appropriately.
166