editors

changeset 45:1cab30e3ec7b

chg readme name
author ne1uno <ne1uno@users.sourceforge.net>
date Wed Dec 07 21:15:03 2011 -0400 (2011-12-07)
parents c2af9b14fdd7
children 1e7bc3b57fc8
files ctags/ReadMe-euphoria.txt
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/ctags/ReadMe-euphoria.txt	Wed Dec 07 21:15:03 2011 -0400
     1.3 @@ -0,0 +1,134 @@
     1.4 +ctags is a very old program to extract identifiers from source,
     1.5 +Exuberant Ctags current release version	5.8 as of 2011
     1.6 +
     1.7 +get ctags source or binary & source from 
     1.8 +from http://ctags.sourceforge.net
     1.9 +or from their svn repo or an archive of the repo trunk
    1.10 +http://ctags.svn.sourceforge.net/viewvc/ctags/trunk/?view=tar
    1.11 +
    1.12 +Euphoria is an opensource rapid development language 
    1.13 +your source can be interpreted or translated and compiled
    1.14 +or simply bound to a backend to produce a standalone executable.
    1.15 +
    1.16 +get euphoria 4.1 development or the stable 4.0 release from 
    1.17 +http://openeuphoria.org/wiki/view/DownloadEuphoria.wc
    1.18 +currently would need the struct branch 
    1.19 +if you wanted to run eui -TEST on the test program
    1.20 +
    1.21 +version 4 is the stable branch
    1.22 +there is alpha and beta 32 and 64 bit binaries available on eubins
    1.23 +see news, forum and wiki. powered by euphoria!
    1.24 +
    1.25 +euphoria is not needed to build or run ctags 
    1.26 +or to run ctags over the test program
    1.27 +or to run ctags for other languages
    1.28 +
    1.29 +currently late 2011 you have to compile ctags to get euphoria
    1.30 +
    1.31 +there are two regex parsers, simple and callback
    1.32 +copy one of the euphoria.c parsers 
    1.33 +to euphoria.c in the ctags source directory
    1.34 +
    1.35 +replace eiffel language in parsers.h 
    1.36 +and in source.mak 2 places with euphoria
    1.37 +alternatly you would have to use the commandline
    1.38 +to force euphoria or eiffel if you had both active
    1.39 +because both languages use .e file name extension
    1.40 +
    1.41 +build ctags executable using one of the makefiles.
    1.42 +on windows any of the minGW compilers works well.
    1.43 +
    1.44 +install or copy the executable to your path
    1.45 +or you can run from the build directory to test
    1.46 +ctags --languages
    1.47 +
    1.48 +ran 
    1.49 +path\ctags.exe -f ctags --recurse=yes --exclude="*.b*" --fields=+a+S+n -V * 
    1.50 +on ctags_euphoria_test.e and euphoria.e
    1.51 +to generate ctags-sample
    1.52 +
    1.53 +Note: 
    1.54 +	the memtype, memstruct, memunion keywords are from the 
    1.55 +	euphoria 4.1 struct branch and not yet official. the 
    1.56 +	extra parsing will have little to no impact for most projects.
    1.57 +	it would not be too complicated to remove those lines from
    1.58 +	euphoria.c if you find you need the extra speed advantage.
    1.59 +	you can also change the TRUE/FALSE option in kinds to enable/disable
    1.60 +
    1.61 +by default the callback euphoria parser collects these kinds of items
    1.62 +
    1.63 +n   namespace x and include y as x
    1.64 +m   memtype
    1.65 +s   memstruct
    1.66 +u   memunion
    1.67 +c   constant
    1.68 +t   type
    1.69 +f   function
    1.70 +p   procedure
    1.71 +i   ifdef,elsifdef,define words
    1.72 +l   label target for loop/goto
    1.73 +(later versions may also collect variable declarations)
    1.74 +
    1.75 +the simple parser collects these kinds only
    1.76 + and may miss some declarations the callback would catch
    1.77 +
    1.78 +m memtype
    1.79 +s memstruct
    1.80 +u memunion
    1.81 +c constant
    1.82 +t type
    1.83 +p procedure
    1.84 +f function
    1.85 +
    1.86 +ctags  --list-kinds=euphoria 
    1.87 +  shows tags for language
    1.88 +to limit the kinds, use commandline something like
    1.89 + --euphoria-kinds=+p-c for only procedures no constants
    1.90 + assuming constants were enabled by default and you don't want them.
    1.91 +
    1.92 +these options might be changed by default in some ctag parsers
    1.93 +
    1.94 +neither parser currently can collect more than the first on the
    1.95 +same line as the constant, type, function or procedure declaration 
    1.96 + in a multiline list of parameters or constants
    1.97 +
    1.98 +public constant x = 0,
    1.99 +  y = 1
   1.100 +-- y is ignored by ctags
   1.101 +
   1.102 +function xyz(atom a,
   1.103 +			atom b)
   1.104 +--b is ignored by ctags 
   1.105 +
   1.106 +
   1.107 +neither euphoria parser really understands euphoria syntax, but, 
   1.108 +running ctags over bad syntax code may cause unpredictable results.
   1.109 +ctags itself is pretty robust and should be fine in any case.
   1.110 +
   1.111 +eui -STRICT -TEST prog is one way to check syntax
   1.112 +
   1.113 +== How to get ctags working with your editor
   1.114 +
   1.115 +PSPad, a little complicated, hots.sourceforge has a solution using
   1.116 +custom javascript and autohotkey scripts built into an installer.
   1.117 +in use there is a Hots system tray icon where you can select ctags
   1.118 +file. only one can be active at a time. when you select an item,
   1.119 +then press the hots key combination, PSPad will jump to the file.
   1.120 +you need absolute paths and line numbers in the ctags file.
   1.121 +
   1.122 +many editors have builtin ctags support.
   1.123 +
   1.124 +see the ctags documents for how to add ctags support to your editor.
   1.125 +
   1.126 +== Bugs & Feature Requests 
   1.127 +
   1.128 +please report any bugs or add a feature request for improvements,
   1.129 +including sample code if applicable.
   1.130 +
   1.131 +the ctags bug tracker has a patch you may want to apply
   1.132 +there may be no effect on the current euphoria parsers
   1.133 +but, the patch was applied before testing.
   1.134 +as of ctags v5.8 the patch wasn't applied to the official sources or svn.
   1.135 +File Added 	425305: fix-regex-callback-count.patch 	2011-10-05 05:12:19 PDT 
   1.136 +http://sourceforge.net/tracker/?func=detail&aid=3418969&group_id=6556&atid=106556
   1.137 +

SCM Home | OpenEuphoria.org Home