Notes on Emacs

• Find files in a project helm projectile
• Indexing (find function, variable definitions and references) If your project is not big, a good solution is rtags c++ indexer. But if your project is large, I recommend using global with ctags. It works really well and it is super fast
  • Installation
    • install Exuberant Ctags http://ctags.sourceforge.net/
    • install Universal Ctags https://github.com/universal-ctags/ctags
      • sudo cp ctags /usr/local/bin/ctags-universal

    • install gtags as:

      ./configure --with-exuberant-ctags=/usr/local/ctags --with-universal-ctags=/usr/local/bin/ctags-universal
      ./make
      sudo make install
      

  • A script to generate index files

    #!/bin/bash
    find . -type d \( -name "skip_foler1" \
    -o -name "skip_folder2" \) -prune -o \
    -type f \( -name "*.cc" -o -name "*.hh" -o -name "*.py" -o -name "*.c" -o -name "*.h" -o -name "*.hidl" \)  \
    -print > file_list
    gtags -i -v -f file_list
    

  • Emacs settings

    ;; --------------------------------------------------
    (use-package helm-gtags :ensure t)
    (require 'helm-gtags)
    (setq
     helm-gtags-ignore-case t
     helm-gtags-auto-update t
     helm-gtags-use-input-at-cursor t
     helm-gtags-pulse-at-cursor t
     helm-gtags-prefix-key "\C-cg"
     helm-gtags-suggested-key-mapping nil
     )
    
    ;;; Enable helm-gtags-mode
    (add-hook 'dired-mode-hook 'helm-gtags-mode)
    (add-hook 'eshell-mode-hook 'helm-gtags-mode)
    (add-hook 'c-mode-hook 'helm-gtags-mode)
    (add-hook 'c++-mode-hook 'helm-gtags-mode)
    (add-hook 'asm-mode-hook 'helm-gtags-mode)
    (add-hook 'python-mode-hook 'helm-gtags-mode)
    
    ;; (define-key helm-gtags-mode-map (kbd "C-c g a") 'helm-gtags-tags-in-this-function)
    (define-key helm-gtags-mode-map (kbd "C-j") 'helm-gtags-select)
    (define-key helm-gtags-mode-map (kbd "M-.") 'helm-gtags-dwim)
    (define-key helm-gtags-mode-map (kbd "M-r") 'helm-gtags-find-rtag)
    (define-key helm-gtags-mode-map (kbd "M-t") 'helm-gtags-find-tag)
    (define-key helm-gtags-mode-map (kbd "M-s") 'helm-gtags-find-symbol)
    ;; (define-key helm-gtags-mode-map (kbd "M-,") 'helm-gtags-pop-stack)
    (define-key helm-gtags-mode-map (kbd "M-*") 'helm-gtags-resume)
    ;;
    (define-key helm-gtags-mode-map (kbd "C-c <left>") 'helm-gtags-previous-history)
    (define-key helm-gtags-mode-map (kbd "C-c <right>") 'helm-gtags-next-history)
    ;;
    ;; (define-key helm-gtags-mode-map (kbd "C-c g") 'vc-git-grep)
    
    

• locate and search
  • global search by M-x rgrep
  • or M-x locate
  • or M-x helm-locate

To use a specific parser to index a specific file types, you can change the field of ':langmap' in your local .globalrc file. For example, if you want to index .hidl as c++, you can map it to c++ type.

:langmap=c\:.c.h,yacc\:.y,asm\:.s.S,java\:.java,cpp\:.c++.cc.cpp.cxx.hxx.hpp.hh.hidl.C.H,php\:.php.php3.phtml:

matgit

• elpy-goto-definition M-.
• xref-pop-marker-stack M-,

• minimap mode
• narrowing for programming

  C-x n n

  Narrow down to between point and mark (narrow-to-region).

  C-x n d

  Narrow down to the current defun (narrow-to-defun).

  C-x n w

  cancel narrow down (widen)

C+x r t (string-rectangle) For more, please see M-x xxx-rectange

• M-x diff-buffer-with-file

or

• C-x s then d

• C-x 3 to add one more frame
• C-x + to equally size all windows

• C-x C-+ increase font size
• C-x C– decrease fint size

M-! run shell command in Emacs

C+h b (describe-bindings) C+h k (describe-key)

• C-c ; Toggle the COMMENT keyword at the beginning of an entry, which won't be exported.
• C-c / search in current buffer shown as a sparse tree.

I have tried rtags with Emacs. It works well after index. It takes a pretty long time to index a large project. Since gtags is much faster and works for me, I don't use it.

sudo apt-get install libclang-dev llvm
cd ~/local/
git clone --recursive http://github.com/Andersbakken/rtags
cd rtags
mkdir build
cd build && cmake -DCMAKE_BUILD_TYPE=Release ..
make
sudo make install

• start $nice ionice -c idle rdm -j6
• Pointing rtags to the av tree

$ rc -J ./source/bazel-out/local_linux-fastbuild/genfiles/compile_commands.json

$ rc -J ./av/build/compile_commands.json

rc –help

http://jasonm23.github.io/emacs-theme-editor/#

• try ESC-x color-theme TAB to show all available themes.
• after you have find a favorite theme, you can add the following to .emacs (theme manoj-dark for example)

(load-theme  'manoj-dark)

• M-x outline-demote
• M-x demote selected region

• add the following at the beginning of an org file

#+startup: beamer
#+LaTeX_CLASS: beamer

• add the following to .emacs

(require 'ox-latex)
(add-to-list 'org-latex-classes
          '("beamer"
            "\\documentclass\[presentation\]\{beamer\}"
            ("\\section\{%s\}" . "\\section*\{%s\}")
            ("\\subsection\{%s\}" . "\\subsection*\{%s\}")
            ("\\subsubsection\{%s\}" . "\\subsubsection*\{%s\}")))

• add the following to .emacs

;; export slides in org mode
;; remember to copy folder "ui" to your pub folder
(add-to-list 'load-path "~/site-lisp/org-s5-master")
(require 'org-export-as-s5)
;;(setq org-s5-theme "railscast")   ; based off `color-theme-railscasts'
(setq org-s5-theme "default")     ; the default S5 theme
;;(setq org-s5-theme "i18n")        ; the i18n theme by the author of S5
;;(setq org-s5-theme "advanced_gfx")

• to export an org buffer to S5 slides, run the following command: org-export-as-s5
• get more themes from: S5_1.3beta7

1. copy ~/site-lisp/org-reveal-master to DIR1
2. copy ~/site-lisp/reveal-master to DIR2
3. setting emacs

;; org reveal export
(add-to-list 'load-path "~/site-lisp/org-reveal-master/")
(require 'ox-reveal)
(setq org-reveal-root "file:///D:/cgliu/emacs-24.2/site-lisp/reveal-master/")