lisp/progmodes/ld-script.el

   1 ;;; ld-script.el --- GNU linker script editing mode for Emacs
   2
   3 ;; Copyright (C) 2001-2017 Free Software Foundation, Inc.
   4
   5 ;; Author: Masatake YAMATO<jet@gyve.org>
   6 ;; Keywords: languages, faces
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software: you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation, either version 3 of the License, or
  13 ;; (at your option) any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 ;;; Commentary:
  24
  25 ;; Major mode for editing GNU linker (ld) scripts.
  26
  27 ;;; Code:
  28
  29 ;; Custom
  30 (defgroup ld-script nil
  31   "GNU linker script code editing commands for Emacs."
  32   :prefix "ld-script-"
  33   :group 'languages)
  34
  35 (defvar ld-script-location-counter-face 'ld-script-location-counter)
  36 (defface ld-script-location-counter
  37   '((t :weight bold :inherit font-lock-builtin-face))
  38   "Face for location counter in GNU ld script."
  39   :group 'ld-script)
  40
  41 ;; Syntax rules
  42 (defvar ld-script-mode-syntax-table
  43   (let ((st (make-syntax-table)))
  44     (modify-syntax-entry ?\  "-"   st)
  45     (modify-syntax-entry ?{ "(}" st)
  46     (modify-syntax-entry ?} "){" st)
  47     (modify-syntax-entry ?\( "()" st)
  48     (modify-syntax-entry ?\) ")(" st)
  49     (modify-syntax-entry ?\[ "(]" st)
  50     (modify-syntax-entry ?\] ")[" st)
  51     (modify-syntax-entry ?_ "_"   st)
  52     (modify-syntax-entry ?. "_"   st)
  53     (modify-syntax-entry ?\\  "\\" st)
  54     (modify-syntax-entry ?: "." st)
  55     (modify-syntax-entry ?, "." st)
  56     (modify-syntax-entry ?? "." st)
  57     (modify-syntax-entry ?= "." st)
  58     (modify-syntax-entry ?* ". 23" st)
  59     (modify-syntax-entry ?/ ". 14" st)
  60     (modify-syntax-entry ?+ "." st)
  61     (modify-syntax-entry ?- "." st)
  62     (modify-syntax-entry ?! "." st)
  63     (modify-syntax-entry ?~ "." st)
  64     (modify-syntax-entry ?% "." st)
  65     (modify-syntax-entry ?< "." st)
  66     (modify-syntax-entry ?> "." st)
  67     (modify-syntax-entry ?& "." st)
  68     (modify-syntax-entry ?| "." st)
  69     (modify-syntax-entry ?\" "\"" st)
  70     st)
  71   "Syntax table used while in `ld-script-mode'.")
  72
  73 ;; Font lock keywords
  74 ;; (The section number comes from ld's info.)
  75 (defvar ld-script-keywords
  76   '(
  77     ;; 3.4.1 Setting the Entry Point
  78     "ENTRY"
  79     ;; 3.4.2 Commands Dealing with Files
  80     "INCLUDE" "INPUT" "GROUP" "AS_NEEDED" "OUTPUT" "SEARCH_DIR" "STARTUP"
  81     ;; 3.4.3 Commands Dealing with Object File Formats
  82     "OUTPUT_FORMAT" "TARGET"
  83     ;; 3.4.4 Assign alias names to memory regions
  84     "REGION_ALIAS"
  85     ;; 3.4.5 Other Linker Script Commands
  86     "ASSERT" "EXTERN" "FORCE_COMMON_ALLOCATION"
  87     "INHIBIT_COMMON_ALLOCATION" "INSERT" "AFTER" "BEFORE"
  88     "NOCROSSREFS" "NOCROSSREFS_TO" "OUTPUT_ARCH" "LD_FEATURE"
  89     ;; 3.5.2 HIDDEN
  90     "HIDDEN"
  91     ;; 3.5.3 PROVIDE
  92     "PROVIDE"
  93     ;; 3.5.4 PROVIDE_HIDDEN
  94     "PROVIDE_HIDDEN"
  95     ;; 3.6 SECTIONS Command
  96     "SECTIONS"
  97     ;; 3.6.4.2 Input Section Wildcard Patterns
  98     "SORT" "SORT_BY_NAME" "SORT_BY_ALIGNMENT" "SORT_BY_INIT_PRIORITY"
  99     ;; 3.6.4.3 Input Section for Common Symbols
 100     "COMMON"
 101     ;; 3.6.4.4 Input Section and Garbage Collection
 102     "KEEP"
 103     ;; 3.6.5 Output Section Data
 104     "BYTE" "SHORT" "LONG" "QUAD" "SQUAD" "FILL"
 105     ;; 3.6.6 Output Section Keywords
 106     "CREATE_OBJECT_SYMBOLS" "CONSTRUCTORS"
 107     "__CTOR_LIST__" "__CTOR_END__" "__DTOR_LIST__" "__DTOR_END__"
 108     ;; 3.6.7 Output Section Discarding
 109     ;; See `ld-script-font-lock-keywords'
 110     ;; 3.6.8.1 Output Section Type
 111     "NOLOAD" "DSECT" "COPY" "INFO" "OVERLAY"
 112     ;; 3.6.8.2 Output Section LMA
 113     "AT"
 114     ;; 3.6.8.4 Forced Input Alignment
 115     "SUBALIGN"
 116     ;; 3.6.8.5 Output Section Constraint
 117     "ONLY_IF_RO" "ONLY_IF_RW"
 118     ;; 3.6.8.7 Output Section Phdr
 119     ":PHDR"
 120     ;; 3.7 MEMORY Command
 121     "MEMORY"
 122     ;; 3.8 PHDRS Command
 123     "PHDRS" "FILEHDR" "FLAGS"
 124     "PT_NULL" "PT_LOAD" "PT_DYNAMIC" "PT_INTERP" "PT_NOTE" "PT_SHLIB" "PT_PHDR"
 125     ;; 3.9 VERSION Command
 126     "VERSION")
 127   "Keywords used of GNU ld script.")
 128
 129
 130 ;; 3.10.2 Symbolic Constants
 131 ;; 3.10.9 Builtin Functions
 132 (defvar ld-script-builtins
 133   '("CONSTANT"
 134     "MAXPAGESIZE"
 135     "COMMONPAGESIZE"
 136     "ABSOLUTE"
 137     "ADDR"
 138     "ALIGN"
 139     "ALIGNOF"
 140     "BLOCK"
 141     "DATA_SEGMENT_ALIGN"
 142     "DATA_SEGMENT_END"
 143     "DATA_SEGMENT_RELRO_END"
 144     "DEFINED"
 145     "LENGTH" "len" "l"
 146     "LOADADDR"
 147     "LOG2CEIL"
 148     "MAX"
 149     "MIN"
 150     "NEXT"
 151     "ORIGIN" "org" "o"
 152     "SEGMENT_START"
 153     "SIZEOF"
 154     "SIZEOF_HEADERS"
 155     "sizeof_headers")
 156   "Builtin functions of GNU ld script.")
 157
 158 (defvar ld-script-font-lock-keywords
 159   (append
 160    `((,(concat "\\_<" (regexp-opt ld-script-keywords) "\\_>")
 161       0 font-lock-keyword-face)
 162      (,(concat "\\_<" (regexp-opt ld-script-builtins) "\\_>")
 163       0 font-lock-builtin-face)
 164      ;; 3.6.7 Output Section Discarding
 165      ;; 3.6.4.1 Input Section Basics
 166      ;; 3.6.8.7 Output Section Phdr
 167      ("/DISCARD/\\|EXCLUDE_FILE\\|:NONE" . font-lock-warning-face)
 168      ("\\W\\(\\.\\)\\W" 1 ld-script-location-counter-face)
 169      )
 170    cpp-font-lock-keywords)
 171   "Default font-lock-keywords for `ld-script-mode'.")
 172
 173 ;;;###autoload
 174 (define-derived-mode ld-script-mode prog-mode "LD-Script"
 175    "A major mode to edit GNU ld script files"
 176   (set (make-local-variable 'comment-start) "/* ")
 177   (set (make-local-variable 'comment-end)   " */")
 178   (set (make-local-variable 'font-lock-defaults)
 179        '(ld-script-font-lock-keywords nil)))
 180
 181 (provide 'ld-script)
 182
 183 ;;; ld-script.el ends here