File: ruby-mode.el.html

Provides font-locking, indentation support, and navigation for Ruby code.

Still needs more docstrings; search below for TODO.

Defined variables (44)

ruby--prettify-symbols-alistValue for ‘prettify-symbols-alist’ in ‘ruby-mode’.
ruby-align-chained-callsIf non-nil, align chained method calls.
ruby-align-to-stmt-keywordsKeywords after which we align the expression body to statement.
ruby-alignable-keywordsKeywords that can be used in ‘ruby-align-to-stmt-keywords’.
ruby-block-beg-keywordsKeywords at the beginning of blocks.
ruby-block-beg-reRegexp to match the beginning of blocks.
ruby-block-hanging-reRegexp to match hanging block modifiers.
ruby-block-mid-keywordsKeywords where the indentation gets shallower in middle of block statements.
ruby-block-mid-reRegexp for where the indentation gets shallower in middle of block statements.
ruby-block-op-keywordsRegexp to match boolean keywords.
ruby-comment-columnIndentation column of comments.
ruby-custom-encoding-magic-comment-templateA custom encoding comment template.
ruby-deep-arglistDeep indent lists in parenthesis when non-nil.
ruby-deep-indent-parenDeep indent lists in parenthesis when non-nil.
ruby-deep-indent-paren-styleDefault deep indent style.
ruby-defun-beg-reRegexp to match the beginning of a defun, in the general sense.
ruby-encoding-magic-comment-styleThe style of the magic encoding comment to use.
ruby-encoding-mapAlist to map encoding name from Emacs to Ruby.
ruby-flymake-use-rubocop-if-availableNon-nil to use the RuboCop Flymake backend.
ruby-font-lock-keywordsAdditional expressions to highlight in Ruby mode.
ruby-here-doc-beg-reRegexp to match the beginning of a heredoc.
ruby-indent-beg-reRegexp to match where the indentation gets deeper.
ruby-indent-levelIndentation of Ruby statements.
ruby-indent-tabs-modeIndentation can insert tabs in Ruby mode if this is non-nil.
ruby-insert-encoding-magic-commentInsert a magic Ruby encoding comment upon save if this is non-nil.
ruby-mode-abbrev-tableAbbrev table for ‘ruby-mode’.
ruby-mode-hookHook run after entering Ruby mode.
ruby-mode-mapKeymap used in Ruby mode.
ruby-mode-menuRuby Mode Menu.
ruby-mode-syntax-tableSyntax table to use in Ruby mode.
ruby-modifier-beg-keywordsModifiers that are the same as the beginning of blocks.
ruby-modifier-beg-reRegexp to match modifiers same as the beginning of blocks.
ruby-modifier-reRegexp to match modifiers.
ruby-negativeRegexp to match where the indentation gets shallower.
ruby-non-block-do-reRegexp to match keywords that nest without blocks.
ruby-operator-reRegexp to match operators.
ruby-percent-literal-beg-reRegexp to match the beginning of percent literal.
ruby-rubocop-configConfiguration file for ‘ruby-flymake-rubocop’.
ruby-singleton-class-reRegexp to match the beginning of a singleton class context.
ruby-symbol-charsList of characters that symbol names may contain.
ruby-symbol-reRegexp to match symbols.
ruby-syntax-before-regexp-reRegexp to match text that can be followed by a regular expression.
ruby-syntax-methods-before-regexpMethods that can take regexp as the first argument.
ruby-use-encoding-mapUse ‘ruby-encoding-map’ to set encoding magic comment if this is non-nil.

Defined functions (60)

ruby--at-indentation-p(&optional POINT)
ruby--electric-indent-p(CHAR)
ruby--insert-coding-comment(ENCODING)
ruby--inverse-string-quote(STRING-QUOTE)
ruby--string-region()
ruby-accurate-end-of-block(&optional END)
ruby-add-log-current-method()
ruby-backward-sexp(&optional ARG)
ruby-beginning-of-block(&optional ARG)
ruby-beginning-of-defun(&optional ARG)
ruby-beginning-of-indent()
ruby-block-contains-point(PT)
ruby-brace-to-do-end(ORIG END)
ruby-calculate-indent(&optional PARSE-START)
ruby-current-indentation()
ruby-deep-indent-paren-p(C)
ruby-do-end-to-brace(ORIG END)
ruby-end-of-block(&optional ARG)
ruby-end-of-defun()
ruby-expr-beg(&optional OPTION)
ruby-find-library-file(&optional FEATURE-NAME)
ruby-flymake--helper(PROCESS-NAME COMMAND PARSER-FN)
ruby-flymake-auto(REPORT-FN &rest ARGS)
ruby-flymake-rubocop(REPORT-FN &rest ARGS)
ruby-flymake-rubocop--use-bundler-p(DIR)
ruby-flymake-simple(REPORT-FN &rest ARGS)
ruby-forward-sexp(&optional ARG)
ruby-forward-string(TERM &optional END NO-ERROR EXPAND)
ruby-here-doc-end-match()
ruby-imenu-create-index()
ruby-imenu-create-index-in-block(PREFIX BEG END)
ruby-in-ppss-context-p(CONTEXT &optional PPSS)
ruby-indent-exp(&optional IGNORED)
ruby-indent-line(&optional IGNORED)
ruby-indent-size(POS NEST)
ruby-indent-to(COLUMN)
ruby-match-expression-expansion(LIMIT)
ruby-mode()
ruby-mode-menu(ARG1)
ruby-mode-set-encoding()
ruby-mode-variables()
ruby-move-to-block(N)
ruby-parse-partial(&optional END IN-STRING NEST DEPTH PCOL INDENT)
ruby-parse-region(START END)
ruby-smie--args-separator-p(POS)
ruby-smie--indent-to-stmt-p(KEYWORD)
ruby-smie--redundant-do-p(&optional SKIP)
ruby-smie-rules(KIND TOKEN)
ruby-special-char-p(&optional POS)
ruby-string-at-point-p()
ruby-syntax-enclosing-percent-literal(LIMIT)
ruby-syntax-expansion-allowed-p(PARSE-STATE)
ruby-syntax-propertize(START END)
ruby-syntax-propertize-expansions(START END)
ruby-syntax-propertize-function(START END)
ruby-syntax-propertize-heredoc(LIMIT)
ruby-syntax-propertize-percent-literal(LIMIT)
ruby-toggle-block()
ruby-toggle-string-quotes()
ruby-verify-heredoc(&optional POS)

Defined faces (0)