nflath / c-eldoc Goto Github PK

View Code? Open in Web Editor NEW

33.0 4.0 15.0 29 KB

eldoc-mode plugin for C source code

Emacs Lisp 99.60% Makefile 0.40%

c-eldoc's Introduction

c-eldoc.el

Display description of the function under the cursor.

Installation

First, download and compile c-eldoc.el

wget http://github.com/nflath/c-eldoc/raw/master/c-eldoc.el

Then, place c-eldoc.el into your site-lisp directory.

Finally, add following lines to your emacs config file (e.g. .emacs).

(add-hook 'c-mode-hook 'c-turn-on-eldoc-mode)
(add-hook 'c++-mode-hook 'c-turn-on-eldoc-mode)

Customization

Cache

c-eldoc.el uses cache to reduce the times of compilation. This cache has expiration time (default 30 seconds) and you can customize this value.

(setq c-eldoc-buffer-regenerate-time 60)

Compile options

You can customize the compiler and the compile options.

Here are the default values.

(defvar c-eldoc-cpp-command "/lib/cpp ") ;; compiler
(defvar c-eldoc-cpp-macro-arguments "-dD -w -P")
(defvar c-eldoc-cpp-normal-arguments "-w -P")
(defvar c-eldoc-includes "`pkg-config gtk+-2.0 --cflags` -I./ -I../ ") ;; include flags

To customize them, use setq.

(setq c-eldoc-cpp-command "/usr/local/bin/clang")

c-eldoc's People

Contributors

Stargazers

Watchers

Forkers

cdkamat emacsmirror huangjs darth10 namikister laynor abdillah evgeniysharapov bad-ptr tisannai raeburn blldw vdedyukhin elderdelp pierre-rouleau

c-eldoc's Issues

Package cl is deprecated in Emacs-27

It would be nice to fix this to prevent warnings on startup of packages that depend on c-eldoc.

Too many hangs when a large header set is included (e.g. webkitgtk)

If I include a large header set like webkitgtk:

(setq c-eldoc-includes "`pkg-config gtk+-3.0  --cflags` -I./ -I../ `pkg-config webkit2gtk-4.0 --cflags`")

then every out-of-cache lookups hangs for some seconds. This makes this package unusable. I haven't profiled it, but there might be some way to optimize this.

Expand the readme

c-eldoc is a great package, and I didn't realise how good it is when I first looked at the readme here.

There's a great readme on https://github.com/mooz/c-eldoc already, could we just reuse that?

About overloaded function

If there is a overloaded function, how does the c-eldoc handle this?

Function doesn’t exist on system lib

When put point into fread(), the message shows,

How to config it to use with system libs?

Thanks!

Lookup always fails when header path is missing

If I use a library which is not found in the paths set by c-eldoc-includes, all lookups fail, including those for which the libraries are found.

Needs to be updated on marmalade

The current version on marmalade is 0.5 which, in particular, does not contain the autoload cookie. It is not part of the GNU ELPA or MELPA. The new version is part of Tom Tromey's ELPA, but I had that turned off since it's been abandoned IIUC. Adding it to MELPA should be very easy, simply adding

(name :url "https://github.com/nflath/c-eldoc.git" 
 :fetcher git)

to pkglist, and testing that it builds. Unfortunately, when I tried to build (some time ago for a different project) some oddities in my environment made it so I couldn't build anything without making some major changes which weren't worth it at the time.

Anyway, updating on Marmalade would be great, and adding to MELPA would also be nice. I don't have much experience with either, but if you want me to try to do either let me know.

Use executable-find

It's good practice not to hard-code the path to commands but to use executable-find instead. For instance:

(defvar c-eldoc-cpp-command (executable-find "/usr/bin/cpp"))