+ Aleph With Beth
+ © Cameron Briggs
+
+
+ Aleph With Beth
+ © Cameron Briggs
+
+ Start Using Aleph with Beth
+ +Desktop Layout
+ +Base layout
+
+Layout when shift is pressed
+
+Layout when alt is pressed
+
+
diff --git a/developer/src/kmc-copy/test/fixtures/projects/disorganized/other/readme.htm b/developer/src/kmc-copy/test/fixtures/projects/disorganized/other/readme.htm
new file mode 100644
index 0000000000..f187388c1e
--- /dev/null
+++ b/developer/src/kmc-copy/test/fixtures/projects/disorganized/other/readme.htm
@@ -0,0 +1,22 @@
+
+
+
+
+
+ Aleph With Beth
+ +A Hebrew keyboard designed to intuitively match the standard QWERTY layout.
+ +© Cameron Briggs
+ + + diff --git a/developer/src/kmc-copy/test/fixtures/projects/disorganized/other/welcome/KeyboardLayout.png b/developer/src/kmc-copy/test/fixtures/projects/disorganized/other/welcome/KeyboardLayout.png new file mode 100644 index 0000000000..d0998e288b Binary files /dev/null and b/developer/src/kmc-copy/test/fixtures/projects/disorganized/other/welcome/KeyboardLayout.png differ diff --git a/developer/src/kmc-copy/test/fixtures/projects/disorganized/other/welcome/KeyboardLayoutAlt.png b/developer/src/kmc-copy/test/fixtures/projects/disorganized/other/welcome/KeyboardLayoutAlt.png new file mode 100644 index 0000000000..f740eec1e3 Binary files /dev/null and b/developer/src/kmc-copy/test/fixtures/projects/disorganized/other/welcome/KeyboardLayoutAlt.png differ diff --git a/developer/src/kmc-copy/test/fixtures/projects/disorganized/other/welcome/KeyboardLayoutShift.png b/developer/src/kmc-copy/test/fixtures/projects/disorganized/other/welcome/KeyboardLayoutShift.png new file mode 100644 index 0000000000..9b243d4dd2 Binary files /dev/null and b/developer/src/kmc-copy/test/fixtures/projects/disorganized/other/welcome/KeyboardLayoutShift.png differ diff --git a/developer/src/kmc-copy/test/fixtures/projects/disorganized/other/welcome/welcome.htm b/developer/src/kmc-copy/test/fixtures/projects/disorganized/other/welcome/welcome.htm new file mode 100644 index 0000000000..717e7bedeb --- /dev/null +++ b/developer/src/kmc-copy/test/fixtures/projects/disorganized/other/welcome/welcome.htm @@ -0,0 +1,28 @@ + + + + + +Start Using Aleph With Beth
+ +Keyboard Layouts
+ +Base layout
+
+Layout when shift is pressed
+
+Layout when alt is pressed
+
+
+
+
diff --git a/developer/src/kmc-copy/test/messages.tests.ts b/developer/src/kmc-copy/test/messages.tests.ts
deleted file mode 100644
index aca98c3ea7..0000000000
--- a/developer/src/kmc-copy/test/messages.tests.ts
+++ /dev/null
@@ -1,51 +0,0 @@
-/*
- * Keyman is copyright (C) SIL International. MIT License.
- */
-
-import 'mocha';
-// import * as path from 'path';
-// import * as fs from 'fs';
-// import { fileURLToPath } from 'url';
-// import { assert } from 'chai';
-import { CopierMessages } from '../src/copier-messages.js';
-import { verifyCompilerMessagesObject } from '@keymanapp/developer-test-helpers';
-import { CompilerErrorNamespace } from '@keymanapp/developer-utils';
-
-describe('CopierMessages', function () {
- it('should have a valid CopierMessages object', function() {
- return verifyCompilerMessagesObject(CopierMessages, CompilerErrorNamespace.Copier);
- });
-
- // it('should generate ERROR_OutputPathAlreadyExists if output path already exists', async function () {
- // const ag = new AbstractGenerator();
- // const callbacks = new TestCompilerCallbacks();
- // const options: GeneratorOptions = {
- // id: 'ERROR_OutputPathAlreadyExists',
- // outPath: path.dirname(fileURLToPath(import.meta.url)),
- // };
- // assert(await ag.init(callbacks, options));
- // const dir = path.join(path.dirname(fileURLToPath(import.meta.url)), 'ERROR_OutputPathAlreadyExists');
- // if(!fs.existsSync(dir))
- // fs.mkdirSync(dir);
- // assert.isFalse(await ag.write({}));
- // assert.isTrue(callbacks.hasMessage(CopierMessages.ERROR_OutputPathAlreadyExists),
- // `messageId ERROR_OutputPathAlreadyExists not generated, instead got: `+JSON.stringify(callbacks.messages,null,2));
-
- // fs.rmdirSync(dir);
- // });
-
- // it('should generate ERROR_CannotWriteOutputFile if it cannot create a folder, e.g. invalid filename', async function () {
- // const ag = new AbstractGenerator();
- // const callbacks = new TestCompilerCallbacks();
- // const options: GeneratorOptions = {
- // id: 'ERROR_CannotWriteOutputFile',
- // outPath: path.dirname(fileURLToPath(import.meta.url)),
- // };
- // assert(await ag.init(callbacks, options));
- // assert.isFalse(await ag.write({
- // '.': {filename: '.', data: new Uint8Array([1,2,3])}
- // }));
- // assert.isTrue(callbacks.hasMessage(GeneratorMessages.ERROR_CannotWriteOutputFile),
- // `messageId ERROR_CannotWriteOutputFile not generated, instead got: `+JSON.stringify(callbacks.messages,null,2));
- // });
-});
diff --git a/developer/src/kmc-generate/package.json b/developer/src/kmc-generate/package.json
index a8e0810338..ba488ff575 100644
--- a/developer/src/kmc-generate/package.json
+++ b/developer/src/kmc-generate/package.json
@@ -54,7 +54,8 @@
"exclude-after-remap": true,
"exclude": [
"test/",
- "src/template/"
+ "src/template/",
+ "src/main.ts"
]
},
"repository": {
diff --git a/developer/src/kmc-generate/src/abstract-generator.ts b/developer/src/kmc-generate/src/abstract-generator.ts
index 6cb8b1e43e..5a6ed46cc0 100644
--- a/developer/src/kmc-generate/src/abstract-generator.ts
+++ b/developer/src/kmc-generate/src/abstract-generator.ts
@@ -53,11 +53,14 @@ export interface GeneratorOptions /* not inheriting from CompilerBaseOptions */
* name of the author of the keyboard
*/
author?: string;
- /**
+
+ // TODO-GENERATE: icon support
+ /* *
* set to true to generate an icon for a Keyman keyboard with the first
* characters of the first specified BCP 47 tag
*/
- icon?: boolean;
+ // icon?: boolean;
+
/**
* description of the keyboard, Markdown permissible
*/
diff --git a/developer/src/kmc-generate/src/basic-generator.ts b/developer/src/kmc-generate/src/basic-generator.ts
index cb69ef5fdd..fe5a5cd304 100644
--- a/developer/src/kmc-generate/src/basic-generator.ts
+++ b/developer/src/kmc-generate/src/basic-generator.ts
@@ -7,6 +7,7 @@
import { KeymanTargets } from "@keymanapp/common-types";
import KEYMAN_VERSION from "@keymanapp/keyman-version";
import { AbstractGenerator, GeneratorArtifacts } from "./abstract-generator.js";
+import { GeneratorMessages } from "./generator-messages.js";
/**
* @internal
@@ -28,7 +29,19 @@ export class BasicGenerator extends AbstractGenerator {
this.languageTags = this.options.languageTags.length
? this.options.languageTags.map(tag => new Intl.Locale(tag).minimize().toString())
: [this.DEFAULT_LOCALE];
- //TODO-GENERATE: validate targets
+
+ // Verify that targets passed in are valid
+ let failed = false;
+ for(const target of this.options.targets) {
+ if(!KeymanTargets.AllKeymanTargets.includes(target)) {
+ this.callbacks.reportMessage(GeneratorMessages.Error_InvalidTarget({target}));
+ failed = true;
+ }
+ }
+ if(failed) {
+ return false;
+ }
+
if(this.options.targets.includes(KeymanTargets.KeymanTarget.any) || this.options.targets.length == 0) {
this.resolvedTargets = KeymanTargets.AllKeymanTargets.filter(target => target != KeymanTargets.KeymanTarget.any);
} else {
@@ -50,6 +63,8 @@ export class BasicGenerator extends AbstractGenerator {
dt.getDate().toString().padStart(2, '0');
this.tokenMap['$PACKAGE_LANGUAGES'] = this.generateLanguageListForPackage();
this.tokenMap['$PLATFORMS_DOTLIST_README'] = this.getPlatformDotListForReadme();
+
+ return true;
}
protected generate(artifacts: GeneratorArtifacts): boolean {
@@ -89,6 +104,8 @@ export class BasicGenerator extends AbstractGenerator {
sourceFile = this.callbacks.path.join(this.templateBasePath, this.templatePath, sourceFile);
const sourceData = this.callbacks.loadFile(sourceFile);
+
+ /* c8 ignore next 4 */
if(sourceData == null) {
// internal error -- source file should be readable
throw new Error(`source file ${sourceFile} does not exist`);
diff --git a/developer/src/kmc-generate/src/generator-messages.ts b/developer/src/kmc-generate/src/generator-messages.ts
index cda0d82fd2..6c9ccfa7d8 100644
--- a/developer/src/kmc-generate/src/generator-messages.ts
+++ b/developer/src/kmc-generate/src/generator-messages.ts
@@ -17,30 +17,67 @@ const SevFatal = CompilerErrorSeverity.Fatal | Namespace;
* @internal
*/
export class GeneratorMessages {
- static Fatal_UnexpectedException = (o:{e: any}) => m(this.FATAL_UnexpectedException, null, o.e ?? 'unknown error');
static FATAL_UnexpectedException = SevFatal | 0x0001;
+ static Fatal_UnexpectedException = (o:{e: any}) => m(
+ this.FATAL_UnexpectedException, null, o.e ?? 'unknown error'
+ );
- static Info_GeneratingProject = (o:{type: string, id: string}) => m(this.INFO_GeneratingProject,
- `Generating project of type ${def(o.type)} with id ${def(o.id)}`);
static INFO_GeneratingProject = SevInfo | 0x0002;
+ static Info_GeneratingProject = (o:{type: string, id: string}) => m(
+ this.INFO_GeneratingProject,
+ `Generating project of type ${def(o.type)} with id ${def(o.id)}`
+ );
static ERROR_CannotCreateFolder = SevError | 0x0003;
- static Error_CannotCreateFolder = (o:{folderName:string, e: any}) => CompilerMessageSpecWithException(this.ERROR_CannotCreateFolder, null,
- `Unable to create folder ${def(o.folderName)}: ${o.e ?? 'unknown error'}`);
+ static Error_CannotCreateFolder = (o:{folderName:string, e: any}) => CompilerMessageSpecWithException(
+ this.ERROR_CannotCreateFolder, null,
+ `Unable to create folder ${def(o.folderName)}: ${o.e ?? 'unknown error'}`
+ );
static ERROR_OutputPathAlreadyExists = SevError | 0x0004;
static Error_OutputPathAlreadyExists = (o:{outPath:string}) => m(
this.ERROR_OutputPathAlreadyExists,
- `Output path ${def(o.outPath)} already exists, not overwriting`);
+ `Output path ${def(o.outPath)} already exists, not overwriting`
+ );
static ERROR_CannotWriteOutputFile = SevError | 0x0005;
- static Error_CannotWriteOutputFile = (o:{filename:string, e: any}) => CompilerMessageSpecWithException(this.ERROR_CannotWriteOutputFile, null,
- `Unable to write file ${def(o.filename)}: ${o.e ?? 'unknown error'}`);
+ static Error_CannotWriteOutputFile = (o:{filename:string, e: any}) => CompilerMessageSpecWithException(
+ this.ERROR_CannotWriteOutputFile, null,
+ `Unable to write file ${def(o.filename)}: ${o.e ?? 'unknown error'}`
+ );
// See also PackageCompilerMessages.WARN_PackageNameDoesNotFollowLexicalModelConventions
static WARN_ModelIdDoesNotFollowLexicalModelConventions = SevWarn | 0x0006;
- static Warn_ModelIdDoesNotFollowLexicalModelConventions = (o:{id: string}) => m(this.WARN_ModelIdDoesNotFollowLexicalModelConventions,
+ static Warn_ModelIdDoesNotFollowLexicalModelConventions = (o:{id: string}) => m(
+ this.WARN_ModelIdDoesNotFollowLexicalModelConventions,
`The id ${def(o.id)} does not follow the recommended model id conventions. The id should be all lower case, `+
`include only alphanumeric characters and underscore (_), not start with a digit, and should have the structure `+
- `Start Using Sample Project
+ ++ # A mighty description +
+ +Keyboard Layout
+ + + + + \ No newline at end of file diff --git a/developer/src/kmc-generate/test/messages.tests.ts b/developer/src/kmc-generate/test/generator-messages.tests.ts similarity index 50% rename from developer/src/kmc-generate/test/messages.tests.ts rename to developer/src/kmc-generate/test/generator-messages.tests.ts index 68c7f741fa..b5d3a8837a 100644 --- a/developer/src/kmc-generate/test/messages.tests.ts +++ b/developer/src/kmc-generate/test/generator-messages.tests.ts @@ -2,15 +2,24 @@ * Keyman is copyright (C) SIL International. MIT License. */ +import * as path from 'node:path'; +import * as fs from 'node:fs'; + import 'mocha'; -import * as path from 'path'; -import * as fs from 'fs'; import { fileURLToPath } from 'url'; import { assert } from 'chai'; -import { GeneratorMessages } from '../src/generator-messages.js'; + import { TestCompilerCallbacks, verifyCompilerMessagesObject } from '@keymanapp/developer-test-helpers'; import { CompilerErrorNamespace } from '@keymanapp/developer-utils'; + +import { GeneratorMessages } from '../src/generator-messages.js'; import { AbstractGenerator, GeneratorOptions } from '../src/abstract-generator.js'; +import { BasicGenerator } from '../src/basic-generator.js'; +import { KeymanKeyboardGenerator } from '../src/keyman-keyboard-generator.js'; +import { LdmlKeyboardGenerator } from '../src/ldml-keyboard-generator.js'; +import { LexicalModelGenerator } from '../src/lexical-model-generator.js'; + +import { options } from './shared-options.js'; describe('GeneratorMessages', function () { const callbacks = new TestCompilerCallbacks(); @@ -62,4 +71,49 @@ describe('GeneratorMessages', function () { assert.isTrue(callbacks.hasMessage(GeneratorMessages.ERROR_CannotWriteOutputFile), `messageId ERROR_CannotWriteOutputFile not generated, instead got: `+JSON.stringify(callbacks.messages,null,2)); }); + + it('should generate ERROR_InvalidTarget if an invalid target is passed in', async function () { + const testOptions: GeneratorOptions = { ...options, + // @ts-ignore ('invalid' could be passed by a user, even if would be a compile error here) + targets: ['invalid'] + }; + const bg = new BasicGenerator(); + const callbacks = new TestCompilerCallbacks(); + assert(await bg.init(callbacks, testOptions)); + assert.isFalse(bg.test_preGenerate()); + assert.isTrue(callbacks.hasMessage(GeneratorMessages.ERROR_InvalidTarget)); + }); + + it('should generate ERROR_InvalidKeymanKeyboardId if an invalid keyboard id is passed in', async function () { + const testOptions: GeneratorOptions = { ...options, + id: '???invalid', + }; + const kkg = new KeymanKeyboardGenerator(); + const callbacks = new TestCompilerCallbacks(); + assert.isTrue(await kkg.init(callbacks, testOptions)); + assert.isNull(await kkg.run()); + assert.isTrue(callbacks.hasMessage(GeneratorMessages.ERROR_InvalidKeymanKeyboardId)); + }); + + it('should generate ERROR_InvalidLdmlKeyboardId if an invalid keyboard id is passed in', async function () { + const testOptions: GeneratorOptions = { ...options, + id: '???invalid', + }; + const lkg = new LdmlKeyboardGenerator(); + const callbacks = new TestCompilerCallbacks(); + assert.isTrue(await lkg.init(callbacks, testOptions)); + assert.isNull(await lkg.run()); + assert.isTrue(callbacks.hasMessage(GeneratorMessages.ERROR_InvalidLdmlKeyboardId)); + }); + + it('should generate ERROR_InvalidLexicalModelId if an invalid lexical model id is passed in', async function () { + const testOptions: GeneratorOptions = { ...options, + id: 'example.???.invalid', + }; + const lmg = new LexicalModelGenerator(); + const callbacks = new TestCompilerCallbacks(); + assert.isTrue(await lmg.init(callbacks, testOptions)); + assert.isNull(await lmg.run()); + assert.isTrue(callbacks.hasMessage(GeneratorMessages.ERROR_InvalidLexicalModelId)); + }); }); diff --git a/developer/src/kmc-generate/test/shared-options.ts b/developer/src/kmc-generate/test/shared-options.ts index 1010c417b4..cc36789fe3 100644 --- a/developer/src/kmc-generate/test/shared-options.ts +++ b/developer/src/kmc-generate/test/shared-options.ts @@ -6,7 +6,8 @@ import { KeymanTargets } from "@keymanapp/common-types"; import { GeneratorOptions } from "../src/abstract-generator.js"; export const options: GeneratorOptions = { - icon: false, + // TODO-GENERATE: icon support + // icon: false, id: 'sample', languageTags: ['en'], name: 'Sample Project', diff --git a/developer/src/kmc-keyboard-info/src/keyboard-info-compiler.ts b/developer/src/kmc-keyboard-info/src/keyboard-info-compiler.ts index ee784429b9..3e1db45aed 100644 --- a/developer/src/kmc-keyboard-info/src/keyboard-info-compiler.ts +++ b/developer/src/kmc-keyboard-info/src/keyboard-info-compiler.ts @@ -12,7 +12,7 @@ import { CompilerCallbacks, KeymanCompiler, CompilerOptions, KeymanCompilerResul import { KmpCompiler } from "@keymanapp/kmc-package"; import { SchemaValidators } from "@keymanapp/common-types"; -import { getFontFamily } from "./font-family.js"; +import { getFontFamily } from "@keymanapp/developer-utils"; const regionNames = new Intl.DisplayNames(['en'], { type: "region" }); const scriptNames = new Intl.DisplayNames(['en'], { type: "script" }); diff --git a/developer/src/kmc-keyboard-info/test/font-family.tests.ts b/developer/src/kmc-keyboard-info/test/font-family.tests.ts index b27fad8d74..d926e75c65 100644 --- a/developer/src/kmc-keyboard-info/test/font-family.tests.ts +++ b/developer/src/kmc-keyboard-info/test/font-family.tests.ts @@ -2,7 +2,7 @@ import * as fs from 'fs'; import { assert } from 'chai'; import 'mocha'; import { makePathToFixture } from './helpers/index.js'; -import { getFontFamily } from '../src/font-family.js'; +import { getFontFamily } from '@keymanapp/developer-utils'; const AFGHAN_TURKMEN_DISPLAY_FONT = makePathToFixture('afghan_turkmen', "Lateef-Regular.ttf"); const AFGHAN_TURKMEN_OSK_FONT = makePathToFixture('afghan_turkmen', "Lateef-Bold.ttf"); diff --git a/developer/src/kmc-keyboard-info/tsconfig.json b/developer/src/kmc-keyboard-info/tsconfig.json index d09b25c560..124c812ecf 100644 --- a/developer/src/kmc-keyboard-info/tsconfig.json +++ b/developer/src/kmc-keyboard-info/tsconfig.json @@ -13,7 +13,6 @@ }, "include": [ "src/**/*.ts", - "src/ttfmeta/lib/*.js", "src/imports/langtags.js", ], "references": [ diff --git a/developer/src/kmc-kmn/src/kmw-compiler/javascript-strings.ts b/developer/src/kmc-kmn/src/kmw-compiler/javascript-strings.ts index 9cdb28a3d9..d31ccdb14c 100644 --- a/developer/src/kmc-kmn/src/kmw-compiler/javascript-strings.ts +++ b/developer/src/kmc-kmn/src/kmw-compiler/javascript-strings.ts @@ -669,7 +669,7 @@ export function JavaScript_OutputString(fk: KMX.KEYBOARD, FTabStops: string, fkp switch(recContext.Code) { case KMX.KMXFile.CODE_ANY: - Index = AdjustIndex(fkp.dpContext, ContextIndex) + 1; // I3910 // I4611 + Index = AdjustIndex(fkp.dpContext, ContextIndex); // I3910 // I4611 Result += nlt + `k.KIO(${len},this.s${JavaScript_Name(recContext.Any.StoreIndex, recContext.Any.Store.dpName)},${Index},t);`; // I4611 break; case KMX.KMXFile.CODE_DEADKEY: @@ -681,7 +681,7 @@ export function JavaScript_OutputString(fk: KMX.KEYBOARD, FTabStops: string, fkp // Note that this is checked in compiler.cpp as well, so this error can probably never occur throw new Error('Unexpected: notany() encountered with invalid version'); } - Result += nlt + `k.KCXO(${len},t,${AdjustIndex(fkp.dpContext, xstrlen(fkp.dpContext))},${AdjustIndex(fkp.dpContext, ContextIndex)+1});`; + Result += nlt + `k.KCXO(${len},t,${AdjustIndex(fkp.dpContext, xstrlen(fkp.dpContext))},${AdjustIndex(fkp.dpContext, ContextIndex)});`; break; case KMX.KMXFile.CODE_IFOPT: case KMX.KMXFile.CODE_IFSYSTEMSTORE: @@ -759,7 +759,7 @@ export function JavaScript_OutputString(fk: KMX.KEYBOARD, FTabStops: string, fkp case KMX.KMXFile.CODE_CONTEXT: if (x > 0 || len == -1) { let xContext = 0; - let n = 0; + let n = 1; while(xContext < fkp.dpContext.length) { // I4611 if(!isGroupReadOnly(fk, fgp)) { Result += ContextChar(n, fkp.dpContext, xContext); @@ -767,7 +767,6 @@ export function JavaScript_OutputString(fk: KMX.KEYBOARD, FTabStops: string, fkp n++; xContext = incxstr(fkp.dpContext, xContext); } - //Result := Result + Format('k.KO(%d,t,k.KC(%d,%d,t));', [len, xstrlen_printing(fkp.dpContext), xstrlen_printing(fkp.dpContext)]); } // else, we don't need to output anything - just don't delete the context len = -1; @@ -779,7 +778,7 @@ export function JavaScript_OutputString(fk: KMX.KEYBOARD, FTabStops: string, fkp } if(!isGroupReadOnly(fk, fgp)) { - Result += ContextChar(rec.ContextEx.Index, fkp.dpContext, xContext); // I4611 + Result += ContextChar(rec.ContextEx.Index + 1, fkp.dpContext, xContext); // I4611 } len = -1; break; diff --git a/developer/src/kmc-kmn/test/fixtures/kmw/test_index_12980.kmn b/developer/src/kmc-kmn/test/fixtures/kmw/test_index_12980.kmn new file mode 100644 index 0000000000..26d2164928 --- /dev/null +++ b/developer/src/kmc-kmn/test/fixtures/kmw/test_index_12980.kmn @@ -0,0 +1,29 @@ +c test_index_12980 generated from template at 2025-01-22 13:25:35 +c Validates index() offsets when used with if() - see #12980 + +store(&VERSION) '14.0' +store(&NAME) 'test_index_12980' +store(&TARGETS) 'web' + + +begin Unicode > use(main) + +group(main) using keys + +store(a) '1' +store(b) '2' +store(c) '3' +store(d) '4' +store(e) '5' +store(f) '6' +store(g) '7' +store(h) '8' + +if(&platform = 'web') any(a) + 'a' > context 'A' +if(&platform = 'web') any(b) + 'b' > context(2) 'B' +if(&platform = 'web') notany(c) + 'c' > context 'C' +if(&platform = 'web') notany(d) + 'd' > context(2) 'D' +nul any(e) + 'e' > context 'E' +nul any(f) + 'f' > context(2) 'F' +nul notany(g) + 'g' > context 'G' +nul notany(h) + 'h' > context(2) 'H' diff --git a/developer/src/kmc-kmn/test/kmw/kmw-compiler.tests.ts b/developer/src/kmc-kmn/test/kmw/kmw-compiler.tests.ts index d90b33c312..5060dc8757 100644 --- a/developer/src/kmc-kmn/test/kmw/kmw-compiler.tests.ts +++ b/developer/src/kmc-kmn/test/kmw/kmw-compiler.tests.ts @@ -218,6 +218,30 @@ describe('KeymanWeb Compiler', function() { assert.lengthOf(callbacks.messages, 2); }); + it('should generate correct index offsets (#12980) for context and context(n) when building a KMW keyboard', async function() { + const filenames = generateTestFilenames('test_index_12980'); + + let result = await kmnCompiler.run(filenames.source, null); + assert.isNotNull(result); + const data = new TextDecoder('utf-8').decode(result.artifacts.js.data); + + function doMatchKIO(s: string) { + const regex = new RegExp('k\\.KIO\\(-1,this\\.'+s+',(.+?),t\\);'); + const m = regex.exec(data); + assert.isNotNull(m, `Could not find match for ${s}`); + assert.equal(m[1], '1', `Expected '${s}' usage to have an index parameter == 1`); + } + + doMatchKIO('s_a_6'); + doMatchKIO('s_b_7'); + + // matches the 4 notany() rules + const matches = [...data.matchAll(/k\.KCXO\(-1,t,1,1\);/g)]; + assert.lengthOf(matches, 4); + + doMatchKIO('s_e_10'); + doMatchKIO('s_f_11'); + }); }); async function run_test_keyboard(kmnCompiler: KmnCompiler, id: string): diff --git a/developer/src/kmc-package/src/compiler/kmp-compiler.ts b/developer/src/kmc-package/src/compiler/kmp-compiler.ts index 607823c7dd..cd6cf6df36 100644 --- a/developer/src/kmc-package/src/compiler/kmp-compiler.ts +++ b/developer/src/kmc-package/src/compiler/kmp-compiler.ts @@ -18,6 +18,8 @@ import { PackageKeyboardTargetValidator } from './package-keyboard-target-valida import { PackageMetadataUpdater } from './package-metadata-updater.js'; import { markdownToHTML } from './markdown.js'; import { PackageValidation } from './package-validation.js'; +import { getFontFamilySync } from "@keymanapp/developer-utils"; +import { setKvkFontData } from './kvk-font-facename.js'; const KMP_JSON_FILENAME = 'kmp.json'; const KMP_INF_FILENAME = 'kmp.inf'; @@ -483,36 +485,36 @@ export class KmpCompiler implements KeymanCompiler { this.callbacks.reportMessage(PackageCompilerMessages.Warn_AbsolutePath({filename: filename})); } + let memberFileData = this.getMemberFileData(kpsFilename, filename); + if(!memberFileData) { + failed = true; + return; + } filename = this.callbacks.resolveFilename(kpsFilename, filename); const basename = this.callbacks.path.basename(filename); - if(!this.callbacks.fs.existsSync(filename)) { - this.callbacks.reportMessage(PackageCompilerMessages.Error_FileDoesNotExist({filename: filename})); - failed = true; - return; + if(KeymanFileTypes.filenameIs(filename, KeymanFileTypes.Binary.VisualKeyboard)) { + if(!this.isKvkFileBinary(memberFileData)) { + // warn the few users who are still doing this -- non-binary .kvk should not be included in package! + this.callbacks.reportMessage(PackageCompilerMessages.Warn_FileIsNotABinaryKvkFile({filename: filename})); + } else { + memberFileData = this.setKvkFontData(kpsFilename, data, filename, memberFileData); + } } - let memberFileData; - try { - memberFileData = this.callbacks.loadFile(filename); - } catch(e) { - this.callbacks.reportMessage(PackageCompilerMessages.Error_FileCouldNotBeRead({filename: filename, e: e})); - failed = true; - return; - } - - this.warnIfKvkFileIsNotBinary(filename, memberFileData); - zip.file(basename, memberFileData); - - // Remove path data from files before JSON save - value.name = basename; }); if(failed) { return null; } + data.files.forEach((value) => { + const basename = this.callbacks.path.basename(value.name); + // Remove path data from files before JSON save + value.name = basename; + }); + // TODO #9477: transform .md to .htm // Remove path data from file references in options @@ -557,26 +559,87 @@ export class KmpCompiler implements KeymanCompiler { return transcodeToCP1252(s); } + private getMemberFileData(kpsFilename: string, filename: string) { + filename = this.callbacks.resolveFilename(kpsFilename, filename); + + if(!this.callbacks.fs.existsSync(filename)) { + this.callbacks.reportMessage(PackageCompilerMessages.Error_FileDoesNotExist({filename: filename})); + return null; + } + + try { + return this.callbacks.loadFile(filename); + } catch(e) { + this.callbacks.reportMessage(PackageCompilerMessages.Error_FileCouldNotBeRead({filename: filename, e: e})); + return null; + } + } + + private setKvkFontData(kpsFilename: string, data: KmpJsonFile.KmpJsonFile, filename: string, kvk: Uint8Array) { + // find the appropriate font to set + const kvkId = this.callbacks.path.basename(filename.toLowerCase(), '.kvk'); + const kbd = data.keyboards.find(k => k.id == kvkId); + if(!kbd) { + // cannot find a matching keyboard + this.callbacks.reportMessage(PackageCompilerMessages.Warn_CannotFindMatchingKeyboardForVisualKeyboard({filename})); + return kvk; + } + const fontFilename = kbd.oskFont || kbd.displayFont; + if(!fontFilename) { + // no font data to set + return kvk; + } + + // Look up the full font filename + const fontFile = data.files.find(file => this.callbacks.path.basename(file.name.toLowerCase()) == fontFilename.toLowerCase()); + if(!fontFile) { + // font cannot be found + this.callbacks.reportMessage(PackageCompilerMessages.Warn_CannotFindFontForKeyboard({id: kbd.id, fontFilename})); + return kvk; + } + + // the font is a filename, included in the .kps + const fontData = this.getMemberFileData(kpsFilename, fontFile.name); + if(!fontData) { + // cannot find source font + this.callbacks.reportMessage(PackageCompilerMessages.Warn_CannotFindFontForKeyboard({id: kbd.id, fontFilename: fontFile.name})); + return kvk; + } + + const fontFacename = getFontFamilySync(fontData); + if(!fontFacename) { + // Font facename could not be extracted from ttf + this.callbacks.reportMessage(PackageCompilerMessages.Warn_CannotReadFont({fontFilename: fontFile.name})); + return kvk; + } + + const result = setKvkFontData(kvk, fontFacename); + if(!result) { + // KVK is invalid + this.callbacks.reportMessage(PackageCompilerMessages.Warn_VisualKeyboardFileIsInvalid({filename})); + return kvk; + } + + return result; + } + /** * Legacy .kmp compiler would transform xml-format .kvk files into a binary .kvk file; now - * we want that to remain the responsibility of the keyboard compiler, so we'll warn the - * few users who are still doing this + * we want that to remain the responsibility of the keyboard compiler. */ - private warnIfKvkFileIsNotBinary(filename: string, data: Uint8Array) { - if(!KeymanFileTypes.filenameIs(filename, KeymanFileTypes.Binary.VisualKeyboard)) { - return; - } - + private isKvkFileBinary(data: Uint8Array) { if(data.byteLength < 4) { // TODO: Not a valid .kvk file; should we be reporting this? - return; + return false; } + // Must start with 'KVKF' if(data[0] != KvkFile.KVK_HEADER_IDENTIFIER_BYTES[0] || data[1] != KvkFile.KVK_HEADER_IDENTIFIER_BYTES[1] || data[2] != KvkFile.KVK_HEADER_IDENTIFIER_BYTES[2] || data[3] != KvkFile.KVK_HEADER_IDENTIFIER_BYTES[3]) { - this.callbacks.reportMessage(PackageCompilerMessages.Warn_FileIsNotABinaryKvkFile({filename: filename})); + return false; } + return true; } } diff --git a/developer/src/kmc-package/src/compiler/kvk-font-facename.ts b/developer/src/kmc-package/src/compiler/kvk-font-facename.ts new file mode 100644 index 0000000000..b7c69da8e8 --- /dev/null +++ b/developer/src/kmc-package/src/compiler/kvk-font-facename.ts @@ -0,0 +1,16 @@ +import { KvkFileReader, KvkFileWriter } from "@keymanapp/common-types"; + +export function setKvkFontData(fileData: Uint8Array, fontFacename: string) { + const reader = new KvkFileReader(); + const kvk = reader.read(fileData); + if(!kvk) { + // kvk is invalid + return null; + } + + kvk.header.ansiFont.name = fontFacename; + kvk.header.unicodeFont.name = fontFacename; + + const writer = new KvkFileWriter(); + return writer.write(kvk); +} \ No newline at end of file diff --git a/developer/src/kmc-package/src/compiler/package-compiler-messages.ts b/developer/src/kmc-package/src/compiler/package-compiler-messages.ts index 9a593a3a11..6545b7d963 100644 --- a/developer/src/kmc-package/src/compiler/package-compiler-messages.ts +++ b/developer/src/kmc-package/src/compiler/package-compiler-messages.ts @@ -164,5 +164,25 @@ export class PackageCompilerMessages { static Error_RequiredParameterMissing = (o:{param: string}) => m( this.ERROR_RequiredParameterMissing, `Source parameter '${def(o.param)}' is required.` ); + + static WARN_CannotFindMatchingKeyboardForVisualKeyboard = SevWarn | 0x0023; + static Warn_CannotFindMatchingKeyboardForVisualKeyboard = (o:{filename: string}) => m( + this.WARN_CannotFindMatchingKeyboardForVisualKeyboard, `Cannot find matching keyboard for visual keyboard file '${def(o.filename)}'.` + ); + + static WARN_CannotFindFontForKeyboard = SevWarn | 0x0024; + static Warn_CannotFindFontForKeyboard = (o:{id: string, fontFilename: string}) => m( + this.WARN_CannotFindFontForKeyboard, `Cannot find font file '${def(o.fontFilename)}' for keyboard '${def(o.id)}'.` + ); + + static WARN_CannotReadFont = SevWarn | 0x0025; + static Warn_CannotReadFont = (o:{fontFilename: string}) => m( + this.WARN_CannotReadFont, `Cannot parse font file '${def(o.fontFilename)}' to get facename.` + ); + + static WARN_VisualKeyboardFileIsInvalid = SevWarn | 0x0026; + static Warn_VisualKeyboardFileIsInvalid = (o:{filename: string}) => m( + this.WARN_VisualKeyboardFileIsInvalid, `Visual keyboard file '${def(o.filename)}' is invalid.` + ); } diff --git a/developer/src/kmc-package/test/fixtures/binary_kvk_file/source/binary_kvk_file.kmx b/developer/src/kmc-package/test/fixtures/binary_kvk_file/source/binary_kvk_file.kmx new file mode 100644 index 0000000000..bd6b832cab Binary files /dev/null and b/developer/src/kmc-package/test/fixtures/binary_kvk_file/source/binary_kvk_file.kmx differ diff --git a/developer/src/kmc-package/test/fixtures/binary_kvk_file/source/binary_kvk_file.kps b/developer/src/kmc-package/test/fixtures/binary_kvk_file/source/binary_kvk_file.kps index de17212a84..1a02984beb 100644 --- a/developer/src/kmc-package/test/fixtures/binary_kvk_file/source/binary_kvk_file.kps +++ b/developer/src/kmc-package/test/fixtures/binary_kvk_file/source/binary_kvk_file.kps @@ -27,7 +27,7 @@(Keyboard Present) | |---|---| |  | Install or select another language/keyboard | diff --git a/ios/docs/help/index.md b/ios/docs/help/index.md index c71c703e72..994bbbda9e 100644 --- a/ios/docs/help/index.md +++ b/ios/docs/help/index.md @@ -18,6 +18,7 @@ title: Keyman for iPhone and iPad 18.0 Help * [Using the Banner on the Keyboard](basic/using-the-banner) * [Switching Between Keyboards](basic/switching-between-keyboards) * [Using a Keyboard](basic/keyboard-usage) +* [Keyboard Gestures](context/gestures) * [Using the Menu](context/) * [Using the Settings Screen](basic/config/) * [Language Settings](basic/language-settings) diff --git a/ios/docs/help/ios_images/gesture-hint.png b/ios/docs/help/ios_images/gesture-hint.png new file mode 100644 index 0000000000..155ba67418 Binary files /dev/null and b/ios/docs/help/ios_images/gesture-hint.png differ diff --git a/ios/docs/help/start/index.md b/ios/docs/help/start/index.md index f48fc3f185..d7bb7ad72e 100644 --- a/ios/docs/help/start/index.md +++ b/ios/docs/help/start/index.md @@ -1,5 +1,5 @@ --- -title: Getting Started +title: Getting Started with Keyman for iPhone and iPad --- * [How To - Adding a Keyboard](searching-for-keyboards) diff --git a/ios/docs/help/troubleshooting/index.md b/ios/docs/help/troubleshooting/index.md index 2f31716c95..1509c74ee6 100644 --- a/ios/docs/help/troubleshooting/index.md +++ b/ios/docs/help/troubleshooting/index.md @@ -1,5 +1,5 @@ --- -title: Troubleshooting +title: Keyman for iPhone and iPad Troubleshooting --- * [How To - Installing fonts](installing-fonts) diff --git a/ios/engine/KMEI/KeymanEngine/es-419.lproj/Localizable.strings b/ios/engine/KMEI/KeymanEngine/es-419.lproj/Localizable.strings index e94c1e7da6..756eb0a49b 100644 --- a/ios/engine/KMEI/KeymanEngine/es-419.lproj/Localizable.strings +++ b/ios/engine/KMEI/KeymanEngine/es-419.lproj/Localizable.strings @@ -226,6 +226,24 @@ /* Text showing name of spacebar caption - language + keyboard */ "menu-settings-spacebar-item-languageKeyboard" = "Idioma y teclado"; +/* Label for the "Adjust Keyboard Height" item on the main settings screen */ +"menu-settings-adjust-keyboard-height" = "Ajustar altura del teclado"; + +/* Title for the "Adjust Keyboard Height" settings child screen */ +"adjust-keyboard-height-title" = "Ajustar teclado"; + +/* Label for "Reset to Default Keyboard Height" button on the adjust height screen */ +"button-label-reset-default-keyboard-height" = "Restablecer altura de teclado predeterminada"; + +/* Instruction text to drag keyboard to resize */ +"keyboard-drag-instructions" = "Arrastre el control de flecha para ajustar la altura del teclado."; + +/* Instruction to rotate to adjust landscape keyboard height (displayed when device is portrait) */ +"portrait-keyboard-rotate-instructions" = "Gire el dispositivo para pasar al modo horizontal."; + +/* Instruction to rotate to adjust portrait keyboard height (displayed when device is landscape) */ +"landscape-keyboard-rotate-instructions" = "Gire el dispositivo para pasar al modo vertical."; + /* Short text for notification: download failure for keyboard */ "notification-download-failure-keyboard" = "Error al descargar el teclado"; diff --git a/ios/engine/KMEI/KeymanEngine/pt-PT.lproj/Localizable.strings b/ios/engine/KMEI/KeymanEngine/pt-PT.lproj/Localizable.strings index 88dea57f70..98d3031a04 100644 --- a/ios/engine/KMEI/KeymanEngine/pt-PT.lproj/Localizable.strings +++ b/ios/engine/KMEI/KeymanEngine/pt-PT.lproj/Localizable.strings @@ -226,6 +226,24 @@ /* Text showing name of spacebar caption - language + keyboard */ "menu-settings-spacebar-item-languageKeyboard" = "Idioma e teclado"; +/* Label for the "Adjust Keyboard Height" item on the main settings screen */ +"menu-settings-adjust-keyboard-height" = "Adjust Keyboard Height"; + +/* Title for the "Adjust Keyboard Height" settings child screen */ +"adjust-keyboard-height-title" = "Adjust Keyboard"; + +/* Label for "Reset to Default Keyboard Height" button on the adjust height screen */ +"button-label-reset-default-keyboard-height" = "Reset to Default Keyboard Height"; + +/* Instruction text to drag keyboard to resize */ +"keyboard-drag-instructions" = "Drag arrow control to adjust keyboard height."; + +/* Instruction to rotate to adjust landscape keyboard height (displayed when device is portrait) */ +"portrait-keyboard-rotate-instructions" = "Rotate device to adjust for landscape."; + +/* Instruction to rotate to adjust portrait keyboard height (displayed when device is landscape) */ +"landscape-keyboard-rotate-instructions" = "Rotate device to adjust for portrait."; + /* Short text for notification: download failure for keyboard */ "notification-download-failure-keyboard" = "Download do teclado falhou"; diff --git a/linux/debian/changelog b/linux/debian/changelog index 3a2dae55f3..99ce27f238 100644 --- a/linux/debian/changelog +++ b/linux/debian/changelog @@ -1,3 +1,15 @@ +keyman (17.0.334-1) unstable; urgency=medium + + * New upstream release. + + -- Eberhard Beilharz
-
+#if DBUS_IMPLEMENTATION == SYSTEMD
#include