aboutsummaryrefslogtreecommitdiff
path: root/lib/handlers/assembly-documentation/arm32.js
diff options
context:
space:
mode:
Diffstat (limited to 'lib/handlers/assembly-documentation/arm32.js')
-rw-r--r--lib/handlers/assembly-documentation/arm32.js71
1 files changed, 71 insertions, 0 deletions
diff --git a/lib/handlers/assembly-documentation/arm32.js b/lib/handlers/assembly-documentation/arm32.js
new file mode 100644
index 000000000..66c680409
--- /dev/null
+++ b/lib/handlers/assembly-documentation/arm32.js
@@ -0,0 +1,71 @@
+// Copyright (c) 2021, Compiler Explorer Authors
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are met:
+//
+// * Redistributions of source code must retain the above copyright notice,
+// this list of conditions and the following disclaimer.
+// * Redistributions in binary form must reproduce the above copyright
+// notice, this list of conditions and the following disclaimer in the
+// documentation and/or other materials provided with the distribution.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+
+import { getAsmOpcode } from '../asm-docs-arm32';
+import { BaseAssemblyDocumentationHandler } from '../base-assembly-documentation-handler';
+
+const CONDITIONAL_INSTRUCTION_REGEXP = /^([A-Za-z]+?)(EQ|NE|CS|CC|MI|PL|VS|VC|HI|LS|GE|LT|GT|LE|AL)$/;
+
+export class Arm32DocumentationHandler extends BaseAssemblyDocumentationHandler {
+ // Notes for conditionals:
+ // https://developer.arm.com/documentation/dui0473/m/condition-codes/condition-code-suffixes-and-related-flags
+ getOpcodeConditional(opcode) {
+ if (!opcode) return;
+
+ const conditionals = {
+ EQ: 'If equal, ',
+ NE: 'If not equal, ',
+ CS: 'If carry set, ',
+ CC: 'If carry clear, ',
+ MI: 'If negative, ',
+ PL: 'If positive or zero, ',
+ VS: 'If overflow, ',
+ VC: 'If no overflow, ',
+ HI: 'If unsigned higher, ',
+ LS: 'If unsigned lower or same, ',
+ GE: 'If signed greater than or equal, ',
+ LT: 'If signed less than, ',
+ GT: 'If signed greater than, ',
+ LE: 'If signed less than or equal, ',
+ };
+
+ const matches = opcode.match(CONDITIONAL_INSTRUCTION_REGEXP);
+ if (matches) {
+ const opcodeDescription = getAsmOpcode(matches[1]);
+ if (!opcodeDescription) return;
+
+ const conditionalText = conditionals[matches[2]] || '';
+
+ opcodeDescription.tooltip = conditionalText + opcodeDescription.tooltip;
+ opcodeDescription.html = conditionalText + opcodeDescription.html;
+
+ return opcodeDescription;
+ }
+ }
+
+ getInstructionInformation(instruction) {
+ const info = getAsmOpcode(instruction) || this.getOpcodeConditional(instruction);
+ return info || null;
+ }
+}