ＤＸライブラリ Android版を使用した Androidアプリで Java のコードでクリップボードを使用する

ＤＸライブラリ Android版を使用した Androidアプリで Java のコードでクリップボードを使用する
( Android Studio編 )

　すべての処理を C++ で実行できれば良いのですが、Android の基本言語が Java である関係で、
今のところ Java を使用しないとクリップボードの機能を使用することができません。

　なので、ここでは『ＤＸライブラリ Android版』には無いクリップボードの機能を Java を使用して
行うための手順を記します。

　1.『AndroidManifest.xml』の内容を Java のコードを実行できるように変更する

　 2.Java のコードを入力する

　 3.Java の情報を取得する C++ のコードを入力する

 1.『AndroidManifest.xml』の内容を Java のコードを実行できるように変更する

　　Android Studio で『ＤＸライブラリ Android版』を使用する Androidアプリのプロジェクトを開き
　画面左側のリストの『app』→『manifests』の中にある『AndroidManifest.xml』を
　ダブルクリックして、内容を表示します。

　　『AndroidManifest.xml』の内容は、使い方ページに沿って編集した場合は以下のようになっていると思いますが、


<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.dxlibtest_androidstudio">

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme"
        android:hasCode="false">
        <activity android:name="android.app.NativeActivity">
            <meta-data android:name="android.app.lib_name"
                android:value="native-lib" />
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>

　　この中の以下のように変更します。(色が緑の部分が変更箇所や追加箇所で、２箇所です)


<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.dxlibtest_androidstudio">

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/AppTheme"
        android:hasCode="true">
        <activity android:name=".MainActivity">
            <meta-data android:name="android.app.lib_name"
                android:value="native-lib" />
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>

</manifest>

　

2.Java のコードを入力する

　　Android Studio の画面左側のリストの『app』→『java』の中には使い方ページに沿ってプロジェクト名を
　『test』にした場合は『com.example.test』があり、更にその中に『MainActivity』がありますので、
　ダブルクリックして内容を表示すると最初から30行ほど書かれていますが、それを全部消して、代わりに
　今回の『クリップボードの処理』を行うための以下のコードを入力します。


package com.example.(プロジェクト名);

import android.app.NativeActivity ;
import android.content.ClipboardManager ;
import android.content.ClipData ;

public class MainActivity extends NativeActivity
{
	// クリップボードの処理が完了したかどうかを保存するメンバー変数
	int FinishClipboardProcess ;

	// クリップボードに設定したり取得したりするテキストを保存するためのメンバー変数
	String ClipboardText ;

	// クリップボードにテキストを設定するための関数
	public void SetClipboardText( String SetText )
	{
		// クリップボードの処理が完了したかどうかを保存するメンバー変数に 0 を代入
		FinishClipboardProcess = 0 ;

		// クリップボードに設定するテキストを ClipboardText にセット
		ClipboardText = SetText ;

		// UIスレッドで実行する処理を登録する
		runOnUiThread( 
			new Runnable() 
			{
				// UIスレッドで呼ばれる関数
				@Override public void run()
				{
					// システムのクリップボードを取得
					ClipboardManager cm = ( ClipboardManager )getSystemService( CLIPBOARD_SERVICE ) ;

					// クリップボードにテキストを設定
					cm.setPrimaryClip( ClipData.newPlainText( "", ClipboardText.subSequence( 0, ClipboardText.length() ) ) ) ;

					// クリップボードの処理が完了したかどうかを保存するメンバー変数に 1 を代入
					FinishClipboardProcess = 1 ;
				}
			}
		) ;
	}

	// クリップボードのテキストを取得するための関数
	public void GetClipboardText()
	{
		// クリップボードの処理が完了したかどうかを保存するメンバー変数に 0 を代入
		FinishClipboardProcess = 0 ;

		// クリップボードのテキストを保存する変数を初期化
		ClipboardText = "" ;

		// UIスレッドで実行する処理を登録する
		runOnUiThread( 
			new Runnable() 
			{
				// UIスレッドで呼ばれる関数
				@Override public void run()
				{
					// システムのクリップボードを取得
					ClipboardManager cm = ( ClipboardManager )getSystemService( CLIPBOARD_SERVICE ) ;
 
					// クリップボードにテキストが保存されていなければ何もしない
					if( cm.hasPrimaryClip() )
					{
						// クリップボードからテキストを取得
						ClipboardText = cm.getPrimaryClip().getItemAt( 0 ).getText().toString() ;
					}

					// クリップボードの処理が完了したかどうかを保存するメンバー変数に 1 を代入
					FinishClipboardProcess = 1 ;
				}
			}
		) ;
	}
}

　( (プロジェクト名)となっている箇所は、お手元のプロジェクトの名前を入力してください )

3.Java の情報を取得する C++ のコードを入力する

　　次に Java で書いたクリップボードの機能を使用する C++ 側のプログラムです。
　　『ＤＸライブラリ Android版』でのみ使用できる GetNativeActivity という関数を使用しています。


#include "DxLib.h"
#include <string.h>

// クリップボードにテキストを設定する
int ClipboardText_Set( const char *Text )
{
	JNIEnv *env ;
	const ANativeActivity *NativeActivity ;

	// アプリの NativeActivity を取得
	NativeActivity = GetNativeActivity() ;

	// Java の関数 SetClipboardText の呼び出し
	{
		// JavaVM とソフト実行用スレッドを関連付け( C++ から Java の機能を使用するために必要 )
		if( NativeActivity->vm->AttachCurrentThreadAsDaemon( &env, NULL ) != JNI_OK )
		{
			return -1 ;
		}

		// Java のクラス MainActivity を取得
		jclass jclass_MainActivity = env->GetObjectClass( NativeActivity->clazz ) ;

		// 関数の引数に渡す jstring を作成
		jstring jstring_SetText = env->NewStringUTF( Text ) ;

		// Java のクラス MainActivity のメンバー関数 SetClipboardText の ID を取得
		jmethodID jmethodID_SetClipboardText = env->GetMethodID( jclass_MainActivity, "SetClipboardText", "(Ljava/lang/String;)V" ) ;

		// Java のクラス MainActivity のメンバー関数 SetClipboardText の呼び出し
		env->CallVoidMethod( NativeActivity->clazz, jmethodID_SetClipboardText, jstring_SetText ) ;

		// 関数の引数用に作成した jstring の参照を削除
		env->DeleteLocalRef( jstring_SetText ) ;

		// Java のクラス MainActivity の参照を削除
		env->DeleteLocalRef( jclass_MainActivity ) ;

		// JavaVM とソフト実行用スレッドの関連付け終了
		NativeActivity->vm->DetachCurrentThread() ;
	}

	// Java の関数 SetClipboardText の処理完了待ち
	while( true )
	{
		// JavaVM とソフト実行用スレッドを関連付け( C++ から Java の機能を使用するために必要 )
		if( NativeActivity->vm->AttachCurrentThreadAsDaemon( &env, NULL ) != JNI_OK )
		{
			return -1 ;
		}

		// Java のクラス MainActivity を取得
		jclass jclass_MainActivity = env->GetObjectClass( NativeActivity->clazz ) ;

		// Java のクラス MainActivity のメンバー関数 FinishClipboardProcess の ID を取得
		jfieldID jfieldID_FinishClipboardProcess = env->GetFieldID( jclass_MainActivity, "FinishClipboardProcess", "I" ) ;

		// Java のクラス (プロジェクト名) のメンバー変数 FinishClipboardProcess の値をローカル変数 FinishClipboardProcess に代入
		int FinishClipboardProcess = env->GetIntField( NativeActivity->clazz, jfieldID_FinishClipboardProcess ) ;

		// Java のクラス MainActivity の参照を削除
		env->DeleteLocalRef( jclass_MainActivity ) ;

		// JavaVM とソフト実行用スレッドの関連付け終了
		NativeActivity->vm->DetachCurrentThread() ;

		// 処理が完了していたらループを抜ける
		if( FinishClipboardProcess == 1 )
		{
			break ;
		}
	}

	// 正常終了
	return 0 ;
}

// クリップボードのテキストを取得する
int ClipboardText_Get( char *TextBuffer, int TextBufferSize )
{
	JNIEnv *env ;
	const ANativeActivity *NativeActivity ;

	// アプリの NativeActivity を取得
	NativeActivity = GetNativeActivity() ;

	// Java の関数 GetClipboardText の呼び出し
	{
		// JavaVM とソフト実行用スレッドを関連付け( C++ から Java の機能を使用するために必要 )
		if( NativeActivity->vm->AttachCurrentThreadAsDaemon( &env, NULL ) != JNI_OK )
		{
			return -1 ;
		}

		// Java のクラス MainActivity を取得
		jclass jclass_MainActivity = env->GetObjectClass( NativeActivity->clazz ) ;

		// Java のクラス MainActivity のメンバー関数 GetClipboardText の ID を取得
		jmethodID jmethodID_GetClipboardText = env->GetMethodID( jclass_MainActivity, "GetClipboardText", "()V" ) ;

		// Java のクラス MainActivity のメンバー関数 GetClipboardText の呼び出し
		env->CallVoidMethod( NativeActivity->clazz, jmethodID_GetClipboardText ) ;

		// Java のクラス MainActivity の参照を削除
		env->DeleteLocalRef( jclass_MainActivity ) ;

		// JavaVM とソフト実行用スレッドの関連付け終了
		NativeActivity->vm->DetachCurrentThread() ;
	}

	// Java の関数 GetClipboardText の処理完了待ち
	while( true )
	{
		// JavaVM とソフト実行用スレッドを関連付け( C++ から Java の機能を使用するために必要 )
		if( NativeActivity->vm->AttachCurrentThreadAsDaemon( &env, NULL ) != JNI_OK )
		{
			return -1 ;
		}

		// Java のクラス MainActivity を取得
		jclass jclass_MainActivity = env->GetObjectClass( NativeActivity->clazz ) ;

		// Java のクラス MainActivity のメンバー関数 FinishClipboardProcess の ID を取得
		jfieldID jfieldID_FinishClipboardProcess = env->GetFieldID( jclass_MainActivity, "FinishClipboardProcess", "I" ) ;

		// Java のクラス (プロジェクト名) のメンバー変数 FinishClipboardProcess の値をローカル変数 FinishClipboardProcess に代入
		int FinishClipboardProcess = env->GetIntField( NativeActivity->clazz, jfieldID_FinishClipboardProcess ) ;

		// 処理が完了していたらテキストを取得する
		if( FinishClipboardProcess == 1 )
		{
			// Java のクラス MainActivity のメンバー変数 ClipboardText の ID を取得
			jfieldID jfieldID_ClipboardText = env->GetFieldID( jclass_MainActivity, "ClipboardText", "Ljava/lang/String;" ) ;

			// Java のクラス MainActivity のメンバー変数 ClipboardText の jstring オブジェクトを取得
			jstring jstring_ClipboardText = ( jstring )env->GetObjectField( NativeActivity->clazz, jfieldID_ClipboardText ) ;

			// Java のクラス MainActivity のメンバー変数 ClipboardText の jstring から C++ 用の文字列のアドレスを取得
			const char *chars_ClipboardText = env->GetStringUTFChars( jstring_ClipboardText, NULL ) ;

			// 文字列をローカル変数 ClipboardText にコピー
			strncpy( TextBuffer, chars_ClipboardText, TextBufferSize - 1 ) ;

			// Java のクラス MainActivity のメンバー変数 ClipboardText の jstring から取得した C++ 用の文字列のアドレスを解放
			env->ReleaseStringUTFChars( jstring_ClipboardText, chars_ClipboardText ) ;

			// Java のクラス MainActivity のメンバー変数 ClipboardText の jstring オブジェクトの参照を削除
			env->DeleteLocalRef( jstring_ClipboardText ) ;
		}

		// Java のクラス MainActivity の参照を削除
		env->DeleteLocalRef( jclass_MainActivity ) ;

		// JavaVM とソフト実行用スレッドの関連付け終了
		NativeActivity->vm->DetachCurrentThread() ;

		// 処理が完了していたらループを抜ける
		if( FinishClipboardProcess == 1 )
		{
			break ;
		}
	}

	// 正常終了
	return 0 ;
}

int android_main( void )
{
	// 背景の色をグレーにする
	SetBackgroundColor( 128,128,128 ) ;

	// ＤＸライブラリの初期化
	if( DxLib_Init() < 0 ) return -1 ;

	// 描画先を裏画面にする
	SetDrawScreen( DX_SCREEN_BACK ) ;

	// クリップボードにテキストを設定する
	ClipboardText_Set( "テストテキスト" ) ;

	// メインループ
	while( ProcessMessage() == 0 )
	{
		char StringBuffer[ 256 ] ;

		// 画面のクリア
		ClearDrawScreen() ;

		// クリップボードのテキストを取得
		ClipboardText_Get( StringBuffer, sizeof( StringBuffer ) ) ;

		// クリップボードのテキストを画面に表示
		DrawFormatString( 0, 0, GetColor( 255,255,255 ), "クリップボードのテキスト[ %s ]", StringBuffer ) ;

		// 裏画面の内容を表画面に反映
		ScreenFlip() ;
	}

	// ＤＸライブラリの後始末
	DxLib_End() ;

	// ソフトの終了
	return 0 ;
}

　

　　以上です。
　　これでプロジェクトを実行すると、画面に『クリップボードのテキスト[ テストテキスト ]』と表示されます。

　　詳細は割愛しますが、C++ から Java にアクセスする基本的な流れは。

　　　①　AttachCurrentThreadAsDaemon でソフト実行用スレッドと JavaVM を関連付け、JNIEnv も取得。

　　　②　GetObjectClass でアプリの Java クラスを取得。

　　　③　GetMethodID や GetFieldID で Java の関数や変数の ID を取得。

　　　④　Call???Method や Get???Field で Java の関数の呼び出しや変数の値を取得。

　　　⑤　DeleteLocalRef で Get???Field で取得したオブジェクト系の変数の参照を削除。

　　　⑥　DeleteLocalRef で GetObjectClass で取得したアプリの Java クラスの参照を削除。

　　　⑦　DetachCurrentThread でソフト実行用スレッドと JavaVM の関連付けを終了。

　　となります。
　　C++ と Java でのやり取りを行う機能( JNI( Java Native Interface ) ) の詳しい扱い方については、検索サイトで
　『Android Java JNI』などのキーワードで検索して調べてみてください。

　　ただ、今回のサンプルでは JNI を使用した処理は ClipboardText_Set と ClipboardText_Get に纏められているので、
　そのまま使う場合は JNI のことを意識しなくてもクリップボードの機能を使用することができます。

戻る