Commit c05676c5 authored by Chong Yidong's avatar Chong Yidong

* srecode: New directory for SRecode template files.

parent e6e267fc
2009-10-03 Chong Yidong <cyd@stupidchicken.com>
* srecode: New directory for SRecode template files.
2009-10-01 Michael Albinus <michael.albinus@gmx.de>
* NEWS: delete-directory has an optional parameter RECURSIVE.
......
;;; cpp.srt --- SRecode templates for c++-mode
;; Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <eric@siege-engine.com>
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
set mode "c++-mode"
set comment_start "/**"
set comment_end " */"
set comment_prefix " *"
;; OVERRIDE THIS in your user or project template file to whatever
;; you use for your project.
set HEADEREXT ".h"
context file
template empty :time :user :file :cpp
----
{{>:filecomment}}
{{#NOTHEADER}}
{{^}}
{{/NOTHEADER}}
{{#HEADER}}
{{>:header_guard}}
{{/HEADER}}
----
template header_guard :file :blank
----
#ifndef {{FILENAME_SYMBOL}}
#define {{FILENAME_SYMBOL}} 1
{{^}}
#endif // {{FILENAME_SYMBOL}}
----
context misc
template arglist
"Insert an argument list for a function.
@todo - Support smart CR in a buffer for not too long lines."
----
({{#ARGS}}{{TYPE}} {{NAME}}{{#NOTLAST}},{{/NOTLAST}}{{/ARGS}})
----
context declaration
prompt TYPE "Return Type: "
template function :indent :blank
"Insert a function declaration."
----
{{?TYPE}} {{?NAME}}{{>:misc:arglist}}
{{#INITIALIZERS}}{{>B:initializers}}{{/INITIALIZERS}}
{
{{^}}
}
----
bind "f"
template function-prototype :indent :blank
"Insert a function declaration."
----
{{?TYPE}} {{?NAME}}{{>:misc:arglist}};
----
prompt TYPE "Data Type: "
template variable :indent :blank
"Insert a variable declaration."
----
{{?TYPE}} {{?NAME}}{{#HAVEDEFAULT}} = {{DEFAULT}}{{/HAVEDEFAULT}};
----
bind "v"
template variable-prototype :indent :blank
"Insert a variable declaration."
----
{{?TYPE}} {{?NAME}};
----
bind "v"
template class :indent :blank
"Insert a C++ class. For use by user insertion.
Override this template to change contents of a class.
Override `class-tag' to override the outer structure of the class."
----
{{<A:class-tag}}
public:
{{>CONSTRUCTOR:classdecl:constructor-tag}}
{{>DESTRUCTOR:classdecl:destructor-tag}}
private:
{{^}}
{{/A}}
----
template subclass :indent :blank
"Insert a C++ subclass of some other class."
sectiondictionary "PARENTS"
set NAME "?PARENTNAME"
----
{{>A:class}}
----
template class-tag :indent :blank
"Insert a C++ class with the expectation of it being used by a tag inserter.
Override this to affect applications, or the outer class structure for
the user-facing template."
----
class {{?NAME}} {{#PARENTS}}{{#FIRST}}: {{/FIRST}}public {{NAME}}{{/PARENTS}}
{
{{^}}
};
----
bind "c"
template method :indent :blank
"Method belonging to some class, declared externally."
----
{{?TYPE}} {{?PARENT}}::{{?NAME}}{{>:misc:arglist}}
{{#INITIALIZERS}}{{>B:initializers}}{{/INITIALIZERS}}
{
{{^}}
}
----
template include :blank
"An include statement."
----
#include "{{?NAME}}"
----
bind "i"
template label :blank :indent
----
{{?NAME}}:
----
context classdecl
template constructor-tag :indent :blank
----
{{?NAME}}{{>:misc:arglist}}
{ {{^}} }
----
;; This one really sucks. How can I finish it?
template initializers :indent
----
{{#FIRST}}:
{{/FIRST}}{{INITNAME}}(){{#NOTLAST}},{{/NOTLAST}}
----
template destructor-tag :indent :blank
----
~{{?NAME}}{{>:misc:arglist}}
{ {{^}} }
----
;;; Base Comment functions for overriding.
context classdecl
template comment-function-group-start :indent :blank
"Used for putting comments in front of a functional group of declarations.
Override this with your own preference to avoid using doxygen."
----
{{>A:classdecl:doxygen-function-group-start}}
----
template comment-function-group-end :indent :blank
"Used for putting comments in front of a functional group of declarations.
Override this with your own preference to avoid using doxygen."
----
{{>A:classdecl:doxygen-function-group-end}}
----
context declaration
template comment-function :indent :blank
"Used to put a nice comment in front of a function.
Override this with your own preference to avoid using doxygen"
----
{{>A:declaration:doxygen-function}}
----
;;; DOXYGEN FEATURES
;;
;;
context classdecl
prompt GROUPNAME "Name of declaration group: "
template doxygen-function-group-start :indent :blank
----
/**
* {{?GROUPNAME}}
* @{
*/
----
template doxygen-function-group-end :indent :blank
----
/**
* @}
*/
----
context declaration
template doxygen-function :indent :blank
----
/**
* @name {{NAME}} - {{DOC}}{{^}}{{#ARGS}}
* @param {{NAME}} - {{DOC}}{{/ARGS}}
* @return {{TYPE}}
*/
----
template doxygen-variable-same-line
----
/**< {{DOC}}{{^}} */
----
template doxygen-section-comment :blank :indent
"Insert a comment that separates sections of an Emacs Lisp file."
----
/** {{?TITLE}}
*
* {{^}}
*/
----
;; end
;;; default.srt --- SRecode templates for srecode-template-mode
;; Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <eric@siege-engine.com>
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
set mode "default"
set comment_start "#"
set COPYRIGHT "This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2, or (at
your option) any later version.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; see the file COPYING. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA."
set DOLLAR "$"
context file
template copyright
----
{{COPYRIGHT:srecode-comment-prefix}}
----
template filecomment :file :user :time
----
{{comment_start}} {{FILENAME}} --- {{^}}
{{comment_prefix}}
{{comment_prefix}} Copyright (C) {{YEAR}} {{?AUTHOR}}
{{comment_prefix}}
{{comment_prefix}} Author: {{AUTHOR}} <{{EMAIL}}>{{#RCS}}
{{comment_prefix}} X-RCS: {{DOLLAR}}Id{{DOLLAR}}{{/RCS}}
{{comment_prefix}}
{{>:copyright}}
{{comment_end}}
----
;; end
\ No newline at end of file
;; doc-c.srt --- SRecode templates for "document" applications
;; Copyright (C) 2008, 2009 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <eric@siege-engine.com>
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
set mode "c++-mode"
set application "document"
context declaration
;;; Notes on the DOCUMENT templates.
;;
;; These templates recycle existing templates for doxygen in the
;; more general C++ template set.
template section-comment :indent :blank
"A comment separating major sections of a file."
----
{{>:declaration:doxygen-section-comment}}
----
template function-comment :tag :indent :blank
"A comment occuring in front of a function.
Recycle doxygen comment code from the more general template set."
----
{{>:declaration:doxygen-function}}
----
template variable-same-line-comment :tag
"A comment occuring after a veriable declaration.
Recycle doxygen comment code from the more general template set."
----
{{>:declaration:doxygen-variable-same-line}}
----
;; These happen to be the same as in a classdecl.
template group-comment-start :blank :indent
"A comment occuring in front of a group of declarations.
Recycle doxygen comment code from the more general template set."
----
{{>:classdecl:doxygen-function-group-start}}
----
template group-comment-end :blank :indent
"A comment occuring at the end of a a group of declarations.
Recycle doxygen comment code from the more general template set."
----
{{>:classdecl:doxygen-function-group-end}}
----
;; Some templates only show up in classdecls.
context classdecl
template group-comment-start :blank :indent
"A comment occuring in front of a group of declarations.
Recycle doxygen comment code from the more general template set."
----
{{>:classdecl:doxygen-function-group-start}}
----
template group-comment-end :blank :indent
"A comment occuring at the end of a a group of declarations.
Recycle doxygen comment code from the more general template set."
----
{{>:classdecl:doxygen-function-group-end}}
----
;; end
;; doc-default.srt --- SRecode templates for "document" applications
;; Copyright (C) 2009 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <eric@siege-engine.com>
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
set mode "default"
set application "document"
context declaration
template section-comment :blank :indent
"A comment occuring in front of a group of declarations."
----
{{comment_start}} {{?TITLE}}
{{comment_prefix}}
{{comment_prefix}} {{^}}
{{comment_end}}
----
template function-comment :tag :indent :blank
"A comment occuring in front of a function."
----
{{comment_start}} {{?NAME}} --
{{DOC:srecode-comment-prefix}}
{{comment_end}}
----
template variable-same-line-comment :tag
"A comment occuring after a veriable declaration."
----
{{comment_start}} {{?DOC}} {{comment_end}}
----
;; These happen to be the same as in a classdecl.
template group-comment-start :blank :indent
"A comment occuring in front of a group of declarations."
----
{{comment_start}} {{?GROUPNAME}} --
{{comment_end}}
----
template group-comment-end :indent
"A comment occuring at the end of a a group of declarations."
----
{{comment_start}} End {{?GROUPNAME}} {{comment_end}}
----
;; Some templates only show up in classdecls.
context classdecl
template group-comment-start :blank :indent
"A comment occuring in front of a group of declarations."
----
{{>:declaration:group-comment-start}}
----
template group-comment-end :indent
"A comment occuring at the end of a a group of declarations."
----
{{>:declaration:group-comment-end}}
----
;; end
\ No newline at end of file
;; doc-java.srt --- SRecode templates for "document" applications
;; Copyright (C) 2009 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <eric@siege-engine.com>
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
set mode "java-mode"
set application "document"
context declaration
;;; Notes on the DOCUMENT templates.
;;
;; These templates recycle existing templates for javadoc in the
;; more general C++ template set.
template section-comment :indent :blank
"A comment separating major sections of a file."
----
{{>:declaration:javadoc-section-comment}}
----
template function-comment :tag :indent :blank
"A comment occuring in front of a function.
Recycle javadoc comment code from the more general template set."
----
{{>:declaration:javadoc-function}}
----
template variable-same-line-comment :tag
"A comment occuring after a veriable declaration.
Recycle javadoc comment code from the more general template set."
----
{{>:declaration:javadoc-variable-same-line}}
----
;; These happen to be the same as in a classdecl.
template group-comment-start :blank :indent
"A comment occuring in front of a group of declarations.
Recycle javadoc comment code from the more general template set."
----
{{>:classdecl:javadoc-function-group-start}}
----
template group-comment-end :blank :indent
"A comment occuring at the end of a a group of declarations.
Recycle javadoc comment code from the more general template set."
----
{{>:classdecl:javadoc-function-group-end}}
----
;; Some templates only show up in classdecls.
context classdecl
template group-comment-start :blank :indent
"A comment occuring in front of a group of declarations.
Recycle javadoc comment code from the more general template set."
----
{{>:classdecl:javadoc-function-group-start}}
----
template group-comment-end :blank :indent
"A comment occuring at the end of a a group of declarations.
Recycle javadoc comment code from the more general template set."
----
{{>:classdecl:javadoc-function-group-end}}
----
;; end
;; ede-make.srt --- SRecode templates for Makefiles used by EDE.
;; Copyright (C) 2008 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <eric@siege-engine.com>
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
set mode "makefile-mode"
set escape_start "{{"
set escape_end "}}"
set application "ede"
context file
template ede-empty :file
----
# Automatically Generated {{FILE}} by EDE.
# For use with: {{MAKETYPE}}
#
# DO NOT MODIFY THIS FILE OR YOUR CHANGES MAY BE LOST.
# EDE is the Emacs Development Environment.
# http://cedet.sourceforge.net/ede.shtml
#
----
context declaration
template ede-vars
----
{{#VARIABLE}}
{{NAME}}={{#VALUE}} {{VAL}}{{/VALUE}}{{/VARIABLE}}
----
;; end
\ No newline at end of file
;;; el.srt --- SRecode templates for Emacs Lisp mode
;; Copyright (C) 2007, 2008, 2009 Free Software Foundation, Inc.
;; Author: Eric Ludlam <zappo@gnu.org>
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
set escape_start "$"
set escape_end "$"
set mode "emacs-lisp-mode"
set comment_start ";;;"
set comment_prefix ";;"
set comment_end ""
set DOLLAR "$"
context file
template section-comment :blank
"Insert a comment that separates sections of an Emacs Lisp file."
----
;;; $^$
;;
----
bind "s"
template empty :user :time :file
"Insert a skeleton for an Emacs Lisp file."
----
$>:filecomment$
;;; Commentary:
;;
;; $^$
;;; Code:
(provide '$FILE$)
;;; $FILENAME$ ends here
----
prompt MODESYM "Major Mode Symbol (sans -mode): "
prompt MODENAME "Nice Name of mode: " defaultmacro "MODESYM"
prompt MODEEXTENSION "File name extension for mode: "
template major-mode :file :blank :indent
"Insert the framework needed for a major mode."
sectiondictionary "FONTLOCK"
set NAME macro "MODESYM" "-mode-font-lock-keywords"
set DOC "Keywords for use with srecode macros and font-lock."
sectiondictionary "MODEHOOK"
set NAME macro "MODESYM" "-mode-hook"
set DOC "Hook run when " macro "MODESYM" " starts."
set GROUP macro "MODESYM" "-mode"
set CUSTOMTYPE "'hook"
sectiondictionary "MODEFCN"
set NAME macro "MODESYM" "-mode"
set DOC "Major-mode for " macro "MODESYM" "-mode buffers."
set INTERACTIVE ""
----
$>:declaration:defgroup$
$>:syntax-table$
$<FONTLOCK:declaration:variable$
'(
)
$/FONTLOCK$
$>:declaration:keymap$
$<MODEHOOK:declaration:variable-option$nil$/MODEHOOK$
;;;###autoload
$<MODEFCN:declaration:function$