From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: =?utf-8?Q?=C3=93scar_Fuentes?= Newsgroups: gmane.emacs.devel Subject: Re: good examples of Emacs modules? Date: Thu, 31 Mar 2016 19:07:29 +0200 Message-ID: <87y48y60fi.fsf@wanadoo.es> References: <56FC5E99.7090804@cs.ucla.edu> <8737r67jbo.fsf@wanadoo.es> <83a8levbaf.fsf@gnu.org> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Trace: ger.gmane.org 1459444092 18536 80.91.229.3 (31 Mar 2016 17:08:12 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 31 Mar 2016 17:08:12 +0000 (UTC) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Thu Mar 31 19:07:58 2016 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1alg4b-0001ja-Sp for ged-emacs-devel@m.gmane.org; Thu, 31 Mar 2016 19:07:58 +0200 Original-Received: from localhost ([::1]:33478 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1alg4b-0005qP-58 for ged-emacs-devel@m.gmane.org; Thu, 31 Mar 2016 13:07:57 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:38981) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1alg4N-0005qH-C7 for emacs-devel@gnu.org; Thu, 31 Mar 2016 13:07:44 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1alg4K-0001uQ-3i for emacs-devel@gnu.org; Thu, 31 Mar 2016 13:07:43 -0400 Original-Received: from plane.gmane.org ([80.91.229.3]:47667) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1alg4J-0001uL-Sj for emacs-devel@gnu.org; Thu, 31 Mar 2016 13:07:40 -0400 Original-Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1alg4H-0001cV-F1 for emacs-devel@gnu.org; Thu, 31 Mar 2016 19:07:37 +0200 Original-Received: from 151.red-79-153-146.dynamicip.rima-tde.net ([79.153.146.151]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Thu, 31 Mar 2016 19:07:37 +0200 Original-Received: from ofv by 151.red-79-153-146.dynamicip.rima-tde.net with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Thu, 31 Mar 2016 19:07:37 +0200 X-Injected-Via-Gmane: http://gmane.org/ Original-Lines: 19 Original-X-Complaints-To: usenet@ger.gmane.org X-Gmane-NNTP-Posting-Host: 151.red-79-153-146.dynamicip.rima-tde.net User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.0.92 (gnu/linux) Cancel-Lock: sha1:pFHEnjV3oVFGfxKjc4fY6EmSfd0= X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 80.91.229.3 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:202514 Archived-At: Eli Zaretskii writes: >> > Everything else is documented in the emacs-module.h header. >> >> The documentation on that file is scant, to say it lightly. We need high >> level descriptions of the APIs, with examples, if possible. Then, a >> chapter on techniques and recommended strategies for creating and using >> modules that reflect common C API designs. Whithout that, the real job >> is not creating a module for libfoo, but figuring out how emacs modules >> are supposed to work. > > You can also look in modules/mod-test/, if you haven't already. Thank you, that file acts as a nice cookbook. Still need to figure out how to best handle a long-lived session with an external API. I'll like to see the high level document that Aurélien started to be expanded, though, and eventually incorporated into the official Emacs documentation.