ENIGMA Development Environment
Website is in read-only mode due to a recent attack.

Show Posts

This section allows you to view all posts made by this member. Note that you can only see posts made in areas you currently have access to.

Messages - Josh @ Dreamland

Announcements / Documentation
« on: May 25, 2010, 09:23:55 PM »
ENIGMA's spent most of its life without a decent documentation. Now it gets a colorful one.

Gary (MahFreenAmeh) and I have been working over the last couple days (between his work and my stats project, now complete) on a parser to convert plain-text documentation into a rather lovely visual display. The display is meant for newer browsers with real features. This basically excludes IE automatically.

Anyway, the first of the documentation (thrown together only for purposes of testing the parser, so it's kind of ugly yet anyway) can be viewed here:

For now, the docs use PNG. All PNGs, including the ENIGMA Logo, are merely renders of SVGs, which the docs will use ASAP. I want an all-text documentation, basically. Docs themselves being plain text, images being SVG which, as I'm sure most of you know, is just XML.

Anyway, do view the test page and post your thoughts. Feel free to recommend ways to beautify or simplify.
Do not complain that the layout uses tables, or I will track you down and murder you in a highly creative manner.

I guess I will start typing up more docs as soon as Gary has a method of adding to them arranged.

Should be interesting.

Peace. Unless you have a vendetta against tables.

Proposals / Re: Recursion
« on: May 25, 2010, 05:24:36 PM »
Yes, because it'd be a crying shame for it to not have a return value for the first processor with a stack size and clock speed of infinity to exit with.

Proposals / Re: Recursion
« on: May 25, 2010, 03:25:30 PM »
Code: (C) [Select]
int main();
void recursion(){
int main(){


Justme: I assume you are on Windows. Correct? Can you confirm that ENIGMA's executable, compileEGMf.exe, is in the same directory as LateralGM's *.jar? Assuming it shipped that way, I need you to confirm that Java is being executed from ENIGMA's directory, not from the location of, for example, a shortcut elsewhere on your system.

The hope is that R4 fixes all of these problems, but large chunks of R3 do not exist in R4, so for now you are better off troubleshooting or waiting a couple weeks.

Announcements / Re: Install script - Ubuntu
« on: May 23, 2010, 06:03:56 PM »
He edited it. :P

Announcements / Re: Experimental GM7/8 saving support in LGM.
« on: May 23, 2010, 12:09:17 AM »
I smell treason. Or is it bacon...

Proposals / Re: Documenting stuff in a more centralized location
« on: May 22, 2010, 06:17:43 PM »
No point, really.

Proposals / Re: Documenting stuff in a more centralized location
« on: May 22, 2010, 04:45:44 PM »
That's a pain in the ass. They're stored in an SQL database, and the intention is to make it somewhat of a Wiki.

Proposals / Re: Documenting stuff in a more centralized location
« on: May 22, 2010, 12:05:55 PM »
Ah, indeed... These SFML docs are very nice. I had to question whether Doxygen had actually produced them, in fact. They've well-structured the mess of methods that need documented from each class... very easy to navigate. I'd really like to use this, in fact, but it introduces a few issues we'll need to handle...

1) We need a way to document the functions ENIGMA puts at the users disposal in a method with which LGM can interface.
2) Although these are very detailed on a per-function basis, I don't see where they've outlined the overall structure of the project (probably because, as a multimedia library, there's no need to).

In fact, the latter gives me my doubts... It seems that Doxygen becomes ugly when there's a lot of interactions between multiple systems. Like Pidgin; I have no idea how they structure protocol plugins because nothing will let me traverse what is called from the UI down. The care they'd have to put into that seems to surpass the structure of Doxygen's output...

If I used this, we'd have a very nice display of what each function does, but we'd have no illustration of what that looked like in the big picture, and we couldn't really use that to allow LGM to give users information about a function based on a downloaded INI/whatever. Unless Doxygen has some API to retrieve lists of such, but even then it would quickly turn into a clusterfuck: LGM is only concerned with docs for functions included from the main source; the ones ENIGMA users can access.

I will look into a workaround with Gary. Maybe Doxygen can cover us, or maybe we can integrate both systems. Doxygen could generate similar docs for individual functions not in main.cpp; the Markdown-like structure I proposed elsewhere could give "bigger picture" documentation and differences between key systems in GM and ENIGMA; and the database-based system Gary has already coded could provide EDL function documentation which would be available to LGM in some easily traversed format. In fact, I'm liking that idea.

We'll continue with what we've already started for now, and then we'll work on getting Doxygen up for other sources, I believe. I will have to talk this over with a2h or Gary, of course, as websites aren't really my forte.

Announcements / Re: Install script - Ubuntu
« on: May 21, 2010, 09:56:26 PM »
You know, as long as this script is for Linux, you may as well call my makefile generator script under CompilerSource/genmake.sh. It'll make sure the damn makefile is current. Would be convenient if SVN could call that thing before commit.

Proposals / Re: Proposed Central Documentation Format
« on: May 21, 2010, 06:41:59 PM »
Assuming Markdown is the format off which I based this idea, it's very nice but unfocused. This format is more tailored to ENIGMA's docs, I hope. I intend to ask Gary for a method of indexing based on group. For example, all --Inconsistency----- Labels, marking differences in behavior between GM and ENIGMA, would be nice if listed for quick lookup.

Proposals / Re: Documenting stuff in a more centralized location
« on: May 21, 2010, 06:22:32 PM »
Doxygen is a sad excuse for what could otherwise be a navigable system. I don't want to put too much effort into this, but I less want to put too little. Doxygen made developing for Pidgin my nightmare. I would never wish that on anyone.

Proposals / Re: Proposed Central Documentation Format
« on: May 21, 2010, 06:09:52 PM »
Further pondering has brought me to the conclusion that this would be a better idea:

Code: [Select]
Down the road, it may be thought frugal to replace ID-based lookup with pointer-based lookup. With that in mind, only the red-black tree will need removed, and as such, should be #ifdef'd out of the picture. The rest of the system, including the iterators, remains entirely applicable, though lookup functions in other sources will need minor modification to re-perfect "with" statements...

The system was chosen because precedence was given to CPU time over memory usage. Offering a wide variety of storage methods while using an additional layer of pointers-to-iterators to maintain a uniform iterator saves an entire level of complexity. To prevent extra CPU cycles from a double-dereferencing resulting from the additional layer, the first element in the iterator shall be the element that the "backbone" structure would otherwise have introduced. Because these iterators are unified, many cycles are saved in testing the type of iterator during with, and measures can be taken to avoid more than a single call of overhead, up front.


<For insight, refer to graphic images/link_graphic.svg>
This graphic illustrates the iterator systems at the object-ID level. Note that this does not necessarily imply that every instance listed by iterator is directly an instance of the object given by that ID. The way ENIGMA is structured, heredity as implemented by GM is best emulated by listing all children under each object-ID list. As such, the lists can be redundant, as well as ambiguous, but for the purposes they serve, neither is a problem.

The instance lookup system is a bit more complicated. This takes the same structure we see above, but implements a "backbone," so to speak. Here, a red-black tree (given by std::map) is used to provide lookup with logarithmic complexity. A call to the find function will return, if present, a "with"-ready iterator. In the case of with(int:100000..Infinity), this iterator can be copied and reset such that next points to NULL. In the case of with(int:all), the map can be prodded for begin() and the iterator can be copied as-is and used to traverse the entire list. This is legal as this list is neither redundant nor ambiguous. <For diagram, see images/link_with_backbone.svg>


That's all I really have right now. This will be in a separate box of the same color, right underneath.

That is actually a good foundation for the instance system documentation. Basically, that should look like this:

Code: [Select]
[future textbox] [philosophy textbox]  ; These are indicated with the --NAME----- headings. Nothing divides them between rows.
[banner graphic that spans both cols]  ; This is indicated by ^<For (.*), see URL$. Note how this "tag" takes the entire line.
[large text box w/ large span][image]  ; This is set off as a new row with -------, then spanned across two columns with an >.
[second large box, with one sentence]  ; Same; no image. Image above is float:right because its code carries to the right end.

So basically, a few symbols:
-- indicates a heading start, ----- indicates the end of the heading type.
------- is like above only without a heading given; it creates a normal box.
--Heading----------, with more hyphens, makes the box span two columns.
> Spans the box over a column.
<For ([^,]*), [(see)(refer to)(view)] PATH> includes an image.
  • Placing the <> in its own line creates a banner image.
  • Placing the <> at the beginning of a line float:left's the image.
  • Placing the <> at the end of a line float:right's the image.
  • Placing the <> inline, of course, creates an inline image. Like a smiley on this board.
* As the first non-white symbol should signify a bullet, as in an unordered list.

Proposals / Re: LGM-ENIGMA options panel.
« on: May 21, 2010, 05:13:06 PM »
Lucid, GNOME Version: 2.30.0.

Announcements / Re: Install script - Ubuntu
« on: May 21, 2010, 05:06:29 PM »
Replace the sudo calls with one call to sudo su; or combine the install parameters.