OpenEuphoria

2. Re: utility program suggestions

• Posted by Kenneth Rhodes <ken_rhodes30436 at yahoo.c?m> May 21, 2008
• 761 views

Jeremy and all:

This a suggestion for a global function extractor/ keyword syntax file
generator. Although, the code for this already exists in several
different Euphoria editors, having a small command line utility which
generates a syntax file would be useful:

1. The output could be used to update existing syntax files as euphoria
grows.  It follows that the syntax files could also be used to
implement context sensitive help systems which are easily kept up-to-date.

2. The output or the utility itself could be extended to create
syntax files for non-euphoria editors such as Kate, Jedit, vim, etc.


Ken Rhodes
Folding at Home: http://folding.stanford.edu/
100% MicroSoft Free
SuSE Linux 10.3
No AdWare, SpyWare, or Viruses!
Life is Good,  

4. Re: utility program suggestions

• Posted by Jeremy Cowgar <jeremy at cowga??com> May 21, 2008
• 747 views

Kenneth Rhodes wrote:
> 
> Jeremy and all:
> 
> This a suggestion for a global function extractor/ keyword syntax file
> generator. Although, the code for this already exists in several
> different Euphoria editors, having a small command line utility which
> generates a syntax file would be useful:
> 

I'm not really sure what you mean. We currently maintain bin/keywords.e which
contains internals. in two global sequences that any program can use.

Can you expand a bit on what you suggesting? (me might just be tired and not
understanding anyone )

--
Jeremy Cowgar
http://jeremy.cowgar.com

6. Re: utility program suggestions

• Posted by Jeremy Cowgar <jeremy at cowga??com> May 21, 2008
• 759 views

Jason Gade wrote:
> 
> 
> I think something like ctags (although I've never really used that) may be
> what
> he's talking about?
> 
> <a
> href="http://en.wikipedia.org/wiki/Ctags">http://en.wikipedia.org/wiki/Ctags</a>
> 
> I know that I've thought about doing that.

Many editors support ctags already. I wonder if we should submit a patch to the
ctags project so that it would then know about Euphoria source. That would
probably be a better route than creating our own ctags. Exposure and instant
support for all sorts of editors.

There are a few other programs we should write Euphoria parsers for such as a
few generic code2html programs and enscript (code to ps/pdf). I am sure there are
others that are widely accepted that would probably be pretty easy to do.

--
Jeremy Cowgar
http://jeremy.cowgar.com

8. Re: utility program suggestions

• Posted by Jason Gade <jaygade at yah??.com> May 21, 2008
• 760 views

You know, both Jeremy and I have entries in the archive for Vim. (Although mine
isn't actually by me -- it's by Travis Beaty).
http://www.rapideuphoria.com/vim-euphoria.zip
http://www.rapideuphoria.com/euphoria-vim.zip

They both contain breakdowns for what you are proposing, but they should
probably be updated.

--
A complex system that works is invariably found to have evolved from a simple
system that works.
--John Gall's 15th law of Systemantics.

"Premature optimization is the root of all evil in programming."
--C.A.R. Hoare

j.

10. Re: utility program suggestions

• Posted by Kenneth Rhodes <ken_rhodes30436 at yaho??com> May 21, 2008
• 769 views

Jeremy Cowgar wrote:
> 
> Kenneth Rhodes wrote:
> > 
> > I made this pitch to Robert Craig once I believe -thought I'd
> > give it another try. Jiri Babor has written several wonderful
> > utility programs which I think would make worthwhile additions
> > to the those already included in /bin/.
> > 
> 
> I think utilities that have a direct relation to helping the Euphoria
> programmer
> is good, however, we also need to think about how much we are adding to
> Euphoria
> for the developers to continue to maintain. If we adopt the code we are really
> saying we will continue to maintain it. 
> 
> I think there needs to be a balance. I am not sure yet, what that balance may
> be.
> 
> --
> Jeremy Cowgar
> <a href="http://jeremy.cowgar.com">http://jeremy.cowgar.com</a>


Point taken.

One question: How long did it take you to "maintain" Jiri's tidy.ex
to the point where you dropped your indent project? How much time
would you have saved had tidy.ex been there in the bin directory?

One comment:
Replace.ex has all of 88 lines of code- take a look at Jiri's code;
the man is a Euphoria programming super star! 
-----------------------------------------------

I don't really mean to belabor the point. I've referenced Jiri's
utility programs several times in response to inquiries in this
forum. I can keep doing it.  :)


Ken Rhodes
Folding at Home: http://folding.stanford.edu/
100% MicroSoft Free
SuSE Linux 10.3
No AdWare, SpyWare, or Viruses!
Life is Good,  

12. Re: utility program suggestions

• Posted by Jeremy Cowgar <jeremy at ?owgar?com> May 21, 2008
• 775 views

Kenneth Rhodes wrote:
> 
> 
> Exactly. My vision is to have a utility program which not only update
> Euphoria core language support, but also generate context sensitive help
> support files for Euphoria and "external" third party libraries and at 
> least color syntax support for non-euphoria editor's such as  Kate, Vim,
> and Jed - further context sensitive help support for external libraries
> could be made available for these editors thru Juergen's EuHTHelp.ex
> command line program.
> 

The new docs for Euphoria are a modified version of the .htx files used in
previous version. It has been greatly simplified and also has very nice PDF and
text generation now also!

http://jeremy.cowgar.com/euphoria/combined.pdf
http://jeremy.cowgar.com/euphoria/combined.txt

(both of those are very old and have been made even better yet)

It also now has inline function documentation that generates Table of Contents,
Alphabetical Indexes, Automatic API Linking, etc...

--**
-- Sort the elements of a sequence into ascending order.
--
-- The elements can be atoms or sequences. The standard compare()
-- routine is used to compare elements.
--
-- Parameters:
--	 x = The sequence to be sorted.
--
-- Returns:
--	 sequence - The original sequence in ascending order
--
-- Comments:
--	 This uses the "Shell" sort algorithm.
--
-- This sort is not "stable", i.e. elements that are considered equal might
-- change position relative to each other.
--
-- Example 1:
--	constant student_ages = {18,21,16,23,17,16,20,20,19}
--	sequence sorted_ages
--	sorted_ages = sort( student_ages )
--	-- result is {16,16,17,18,19,20,20,21,23}
--
-- See Also:
--	 compare
--	 sort_reverse
--	 sort_user
--	 custom_sort

global function sort(sequence x)
...

The doc tool already extracts the documentation and function/procedure
signatures. It probably would not be a far stretch to make it a generic program
extracting the information into a common format that people could use for such
tasks as you are speaking.

Without a common documentation means, though, it would be impossible for a
common program to extract function and documentation from source. It could
potentially know a few different doc styles and do it's best.

--
Jeremy Cowgar
http://jeremy.cowgar.com