Travis testing

.travis.yml

@@ -1,7 +1,6 @@
 ---
 sudo: required
 dist: trusty
-group: deprecated-2017Q4
 language: rust
 cache:
   cargo: true
@@ -32,6 +31,7 @@ jobs:
         - CARGO_FLAGS="--features 'strict'"
       os: linux
       before_script:
+        - sudo apt update
         - sudo apt install -y texinfo libgif-dev libxpm-dev
         - travis_wait rustup install $(cat rust-toolchain)
       script:
@@ -70,6 +70,7 @@ jobs:
     - stage: cerrors
       os: linux  # No need to run this everywhere
       before_script:
+        - sudo apt update
         - sudo apt install -y texinfo libgif-dev libxpm-dev
         - travis_wait rustup install $(cat rust-toolchain)
         - ./autogen.sh && ./configure --without-makeinfo --with-x=no --with-ns=no --without-gconf --without-gsettings --with-gif=no
@@ -80,3 +81,16 @@ jobs:
 notifications:
   fast_finish: true
   email: false
+  webhooks:
+    urls:
+      - https://remacs-rustfmt-check.herokuapp.com/verify-results
+    on_failure: always
+    on_success: never
+    on_start: never
+    on_cancel: never
+    on_error: always
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - os: osx

CONTRIBUTING.md

@@ -19,7 +19,8 @@ Thank you for contributing to Remacs!
   you have the correct version by using rustup (it will use the
   correct version based on our [toolchain
   file](https://github.com/rust-lang-nursery/rustup.rs#the-toolchain-file))
-  and running `rustup component add rustfmt-preview`
+  and running `rustup component add rustfmt-preview`. See
+  [Helpful Hooks](#helpful-hooks) for help to automatate this verification.
 * Add docstrings to your Rust functions `/// This function does ...`
 * _Really_ great PRs include tests. See
   [Writing Tests](#writing-tests) for more information.
@@ -52,6 +53,20 @@ would belong in `test/rust_src/src/keyboard-tests.el`. If you wrote
 the tests in `test/src/` while porting just copy the code over to the
 equivalent file in `test/rust_src/src` before submitting the PR.
 
+## Helpful Hooks
+
+The script `rust_src/src/admin/pre-commit` performs some basic checks
+to see if any style rule is violated. To run it automatically before
+every commit, go to the git root level and run the following commands:
+
+```sh
+cd .git/hooks
+ln -s ../../rust_src/admin/pre-commit pre-commit
+```
+
+Among other things, the script will ensure that the code is formatted
+properly in line with the project's guidelines.
+
 ## Getting your PRs merged
 
 * Your PR needs to be reviewed by a collaborator. See the !(CONTRIBUTORS)
@@ -106,11 +121,5 @@ guidelines:
 
 Below are a list of common mistakes we catch in code review.
 
-* Lisp_Object v. LispObject. The name `Lisp_Object` is from C code and
-  it represents an `int`. It will be a 64bit number on 64bit systems
-  and 32bit on 32bit systems. `LispObject` is a Rust wrapper which
-  provides methods. C functions need the C representation. Rust
-  functions usually take `LispObject` but sometimes they use
-  `Lisp_Object` instead.
 * Prefer `EmacsInt::from(foo)` over `foo as EmacsInt`. The compiler will
   be able to warn you if the conversion is lossy.

README.md

@@ -275,8 +275,8 @@ handles these definitions for us:
 
 /// Return t if OBJECT is a number.
 #[lisp_fn]
-fn numberp(object: LispObject) -> LispObject {
-    LispObject::from_bool(object.is_number())
+fn numberp(object: LispObject) -> bool {
+    object.is_number()
 }
 ```
 
@@ -515,3 +515,4 @@ impl LispObject {
     }
 }
 ```
+<!-- Just testing -->

appveyor.yml

@@ -1,14 +1,43 @@
-version: 1.0.{build}
-os:
-  - Visual Studio 2017
-clone_depth: 1
-platform:
-  - x64
 environment:
+  global:
+    PROJECT_NAME: remacs
   matrix:
-    - TOOLCHAIN_VERSION: 14.0
-      RUST: nightly
-init:
-  - ps: iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/appveyor/ci/master/scripts/enable-rdp.ps1'))
+    - TARGET: x86_64-pc-windows-gnu
 
-build_script: .appveyor.bat
+image: Visual Studio 2015
+
+# Install Rust and Cargo
+# (Based on from https://github.com/rust-lang/libc/blob/master/appveyor.yml)
+install:
+  - set /p REMACS_RUST_VERSION=<rust-toolchain
+  - appveyor-retry appveyor DownloadFile https://win.rustup.rs/ -FileName rustup-init.exe
+  - rustup-init.exe --default-host %TARGET% --default-toolchain %REMACS_RUST_VERSION% -y
+  - set PATH=%PATH%;C:\Users\appveyor\.cargo\bin;C:\msys64\usr\bin
+  - rustc -Vv
+  - cargo -V
+  - set MSYSTEM=MINGW64
+  - C:\msys64\usr\bin\bash --login -c "pacman -Syy"
+  - C:\msys64\usr\bin\bash --login -c "pacman -Syu --noconfirm base-devel"
+  - C:\msys64\usr\bin\bash --login -c "pacman -Syu --noconfirm mingw-w64-x86_64-toolchain"
+  - C:\msys64\usr\bin\bash --login -c "pacman -Syu --noconfirm mingw-w64-x86_64-xpm-nox mingw-w64-x86_64-libtiff"
+  - C:\msys64\usr\bin\bash --login -c "pacman -Syu --noconfirm mingw-w64-x86_64-giflib mingw-w64-x86_64-jbigkit"
+  - C:\msys64\usr\bin\bash --login -c "pacman -Syu --noconfirm mingw-w64-x86_64-libpng mingw-w64-x86_64-libjpeg-turbo"
+  - C:\msys64\usr\bin\bash --login -c "pacman -Syu --noconfirm mingw-w64-x86_64-librsvg mingw-w64-x86_64-libxml2"
+  - C:\msys64\usr\bin\bash --login -c "pacman -Syu --noconfirm mingw-w64-x86_64-gnutls"
+
+# test_script takes care of building for us, so disable Appveyor's
+# build stage. This prevents the "directory does not contain a project
+# or solution file" error.  source:
+# https://github.com/starkat99/appveyor-rust/blob/master/appveyor.yml#L113
+build: false
+
+# Equivalent to Travis's `script` phase
+test_script:
+  - C:\msys64\usr\bin\bash --login -c "cd /c/projects/remacs && ./autogen.sh"
+  - C:\msys64\usr\bin\bash --login -c "cd /c/projects/remacs && PKG_CONFIG_PATH=/mingw64/lib/pkgconfig ./configure --without-imagemagick"
+  - C:\msys64\usr\bin\bash --login -c "cd /c/projects/remacs && make"
+  - C:\msys64\usr\bin\bash --login -c "cd /c/projects/remacs && make check"
+
+branches:
+  only:
+    - master

lisp/emacs-lisp/find-func.el

@@ -297,13 +297,17 @@ TYPE should be nil to find a function, or `defvar' to find a variable."
                      (indirect-function
                       (find-function-advised-original identifier))))))
            (rust-fname (replace-regexp-in-string "-" "_" fname))
-           ;; XXX: also find #[lisp_fn(name = "fname")]
            (regex (rx-to-string
-                   `(and "fn" (+ space) ,rust-fname "("))))
+                   `(and "fn" (+ space) ,rust-fname "(")))
+           (lisp-fn-name-regex (rx-to-string
+                                `(and "#[" (* space) "lisp_fn" (* space)
+                                      "(" (* space) "name" (* space) "="
+                                      (* space) "\"" ,fname))))
       (with-current-buffer (find-file-noselect file)
         (goto-char (point-min))
-        (unless (re-search-forward regex nil t)
-          (error "Can't find source for %s" identifier))
+        (unless (re-search-forward lisp-fn-name-regex nil t)
+          (unless (re-search-forward regex nil t)
+            (error "Can't find source for %s" identifier)))
         (cons (current-buffer) (match-beginning 0))))))
 
 

rust_src/Cargo.toml

@@ -9,7 +9,7 @@ version = "0.1.0"
 build = "build.rs"
 
 [dependencies]
-remacs-lib = { version = "0.1.0", path = "remacs-lib/" }
+remacs-lib = { version = "0.1.0", path = "remacs-lib" }
 remacs-macros = { version = "0.1.0", path = "remacs-macros" }
 base64 = "0.9"
 clippy = { version = "*", optional = true }

rust_src/README.md

@@ -30,13 +30,13 @@ In order to use `make_float` in the Rust code, the "foreign function" needs to b
 
 ```rust
 extern "C" {
-    pub fn make_float(float_value: c_double) -> Lisp_Object;
+    pub fn make_float(float_value: c_double) -> LispObject;
 }
 ```
 
 There are two remaining unknowns:
 1. `c_double`
-2. `Lisp_Object`
+2. `LispObject`
 
 First, `c_double` is a type representing a C `double`. It is defined in the [`libc`](https://doc.rust-lang.org/book/first-edition/ffi.html#a-note-about-libc) crate and imported in Remacs as follows:
 
@@ -48,10 +48,10 @@ use libc::{c_double, /* ... */ };
 // ...
 ```
 
-Second, `Lisp_Object` is a struct containing an EmacsInt:
+Second, `LispObject` is a struct containing an EmacsInt:
 
 ```rust
-pub struct Lisp_Object(EmacsInt);
+pub struct LispObject(EmacsInt);
 ```
 
 The later is a type generated at build time (cf. [build.rs](http://doc.crates.io/build-script.html)) to mimic how they are in C:
@@ -61,7 +61,7 @@ Now everything is defined, `make_float` can be used in Rust. For example in `rem
 ```rust
     #[inline]
     pub fn from_float(v: EmacsDouble) -> LispObject {
-        LispObject::from_raw(unsafe { make_float(v) })
+        unsafe { make_float(v) }
     }
 ```
 

rust_src/admin/build-and-run-remacs.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+trap handler SIGINT
+
+handler() {
+    # Sane resume
+    echo "Ctrl-c caught"
+}
+
+set -e
+
+# Instead of make clean at top level which also recompiles all of the elisp
+(cd src && make clean)
+(cd rust_src && cargo clean)
+
+# Build with full debug possibilities
+CFLAGS='-O0 -g3' ./configure --enable-checking='yes,glyphs' --enable-check-lisp-object-type
+make -j8  # If j8 is too aggressive for your system adjust accordingly.
+
+# This eval ensures that escaped parameters remain escaped.
+eval "src/remacs $@"

rust_src/admin/did-it-work.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+echo "Testing build and compile of remacs with arguments: $@"
+
+rust_src/admin/build-and-run-remacs.sh "$@"
+
+result=$?
+
+if [ $? -ne 0 ]; then
+    exit $result
+fi
+
+read -r -p "Did it work? [Ny]" work
+case "$work" in
+    Y|y)
+        exit 0
+        ;;
+    *)
+        exit 1
+        ;;
+esac

rust_src/admin/pre-commit

@@ -43,13 +43,38 @@ if [ -z "$stripped_diff" ]; then
 	echo -e "success."
 else
 	echo -e "FAIL!"
-	echo "$diff"
+	echo -e "Following code is not formatted with rustfmt. Make sure to run 'make rustfmt' from git root.\n"
+	echo -e "$diff\n"
 	errors=1
 fi
 
+
+# Check if emacs_abort is used
+EMACS_ABORT_PATTERN='\+.*emacs_abort'
+if [ "$(git diff --cached --diff-filter=ACM | grep $EMACS_ABORT_PATTERN)" != "" ]; then
+    cat <<EOF
+Some files use emacs_abort. Use panic! with a string explaining cause instead. See $GIT_TOPLEVEL/rust_src/src/buffers.rs for examples.
+
+EOF
+    errors=1
+fi
+
+# Check if eassert is used
+EASSERT_PATTERN='\+.*eassert'
+# Check for eassert
+if [ "$(git diff --cached --diff-filter=ACM | grep $EASSERT_PATTERN)" != "" ]; then
+    cat <<EOF
+Some files use eassert. Use debug_assert! instead. See $GIT_TOPLEVEL/rust_src/lisp.rs for examples.
+
+EOF
+    errors=1
+fi
+
+
 if [ "$errors" != 0 ]; then
-	echo "Failed"
-	exit 1
+    echo "pre-commit checks failed"
+    echo "To commit anyway, pass --no-verify to git commit."
+    exit 1
 else
 	echo "OK"
 fi