Planet SoC -

VICTORY!

cmfoil — Wed, 13 Aug 2008 02:11:02 +0200

Well, some victory!

Example.h:



/** This is a block describing enum

 */

enum color { RED, BLUE, GREEN };

/*! This is describing class foo

 */

class Foo {

 public:

  Foo() { }

  enum speed { IMPULSE=10, WARP=20, LUDICROUS=30 };

  void enum_test(speed s);

};

/*! This is describing enum test

 \param c the color c

 \param s the speed

 */

void enum_test(color c, Foo::speed s);

The TOP of foo.java

/* This was generated from emitProxyClassDefAndCPPCasts() */ /** * This is describing class foo * */

public class Foo {

and finally-



public class example {

/* This was generated from moduleClassFunctionHandler() */

/**

 * This is describing enum test

 *

 * @param   s the speed

 * @param   c the color c

 */

  public static void enum_test(color c, Foo.speed s) {

    exampleJNI.enum_test(c.swigValue(), s.swigValue());

  }

}

WOOHOO!!!

Lots more to work on, but getting it to go all the way through feels nice.
The extra text I generate right (what java.cxx function it came from) is just helping me make sure everything is related to/attaches in the right place. :)
whee!

Back AGain!

cmfoil — Sat, 09 Aug 2008 08:34:55 +0200

Wish I still wasn’t so tired from being sick! But on the nice side, the Olympic opening ceremony was wonderful :) Couldn’t help but watch it!
Trying to finish what I had started on my laptop on my trip has been a little hairy- mostly I’ve been having to rewrite things to get them to actually work, but it’s given me some good opportunities to reconsider how much work I want the language modules to have to do (Which is, of course, as little as possible- and preferably in a manner that leaves all the modules I am not going to mess with untouched!)
With any luck though, my build tomorrow should be putting my javaDoc into the java proxy files. I still haven’t worked out my problem with implementing a %feature, but I decided It would probably be best to get it working end to end first- plus there is the option of simply adding in a new blob of doxygen with a structural command into the interface file itself. (Note to self: make sure to bring this up with Olly TOMORROW!)

First spam comment!

cmfoil — Thu, 24 Jul 2008 08:48:16 +0200

First spam comment! How exciting. :p It’s on some post down below. Other than that, committing tomorrow instead . Oof, I feel behind! William’s post on the mailing list gave me a lot to chew on though, need to reply formally to both of my threads tomorrow ( _really_ tomorrow) as well. I also need to make sure to exist on the swig gsoc channel more- haven’t been holding to that.
Other than that- still need to figure out best way to deal with straight C/C++ comments.

Update Jul 22

cmfoil — Wed, 23 Jul 2008 09:10:22 +0200

Thunderstorms all morning + keeping watch over a very neurotic dog during said storms did not bode well for our heroine. However, tomorrow should be the update of a build with some fixes/extensions to the translator module as well as what I talked about yesterday implemented in SWIG. As well as (hopefully) a good plan for a few of the language modules. Should give me some good talking material :)
also, memo to self- need to still discuss how to appropriately put in a new command line option, or what, in order to make my module run. Seems like disabling the functionality would be as easy as just turning off parsing the tokens or placing them into the tree.

Outline

cmfoil — Tue, 22 Jul 2008 09:04:32 +0200

Ahhhh, I feel too tired to clearly articulate myself right now. I think I’m going to have to finish this tomorrow morning. I need to stop working/blogging so late- I’m really much more in my element in the morning… Like Cinderella’s coach, my brain turns into a pumpkin past midnight- which makes my time commitment from 7-11pm M T TH a little inconvenient ><
Plan details
Stage 1:

Picking up comments
in cscanner.c at case SWIG_TOKEN_COMMENT:
(around line 420 in my version)
3 types of tokens will be returned
-for standard doxygen blobs (aka /** or ///, //! etc) DOXYGENSTRING

-for post comments suchas /**< ///< etc (which are associated with the last thing encountered, see “Putting comments after members” at http://www.stack.nl/~dimitri/doxygen/docblocks.html for more info) DOXYGENPOSTCOMMENT

-for normal C/C++ comments CSTYLECOMMENT

Stage 2:
Attachment into the parse tree
in parser.y

General Doxygen Comments:
there are a few difficulties here- one being that occasionally comments exist independent of the location of the object they describe- they contain structural indicators:

\struct to document a C-struct.
\union to document a union.
\enum to document an enumeration type.
\fn to document a function.
\var to document a variable or typedef or enum value.
\def to document a #define.
\typedef to document a type definition.
\file to document a file.
\namespace to document a namespace.
\package to document a Java package.
\interface to document an IDL interface.

The best possible way, in my opinion, to deal with these is to make them their own nodes. It seems like it is standard to put any structural commands as the first command in a blob- so :
incoming doxygen strings are scanned until the first command is encountered, then the command is tested to see if it belongs to this small list. If it does belong, a new NODE is created with only an attribute named something like structuralDoxygenComment, containing the Doxygen Blob. (is making new node okay to do?)

Otherwise it is handled per usual- currentDoxygenComment would be set to the comment, and when a new node is formed the Doxygen Comment is attached as an attribute.

Post Comments would be added to the previous node by appending them to whatever existing (or not existing) doxygen comment entity may be an attribute in the node. The previous node would be kept track of by a global pointer.

C/C++ Comments are tricky.. because there are two ways that are common to comment:
//Function foo
int foo();

or int foo(); //the function foo
I’m not sure how to distinguish between the two >.< It doesn’t seem like it would be efficient to make every little C/C++ comment its own node, but I’m also not sure how to get it to associate C/C++ comments with the proper object given the ambiguity of C/C++ comments.

In general, by that point all “Traditional” and post-comments that are describing the same element should be in the same “blob” passed to my module- so they would be processed “together” by my blob-translating module.
My thoughts on SWIG directives are now too fuzzy to explain before I’ve slept >< Reguardless, the end result should be that my separate module doesn’t have to do anything more than translate what its given- and thus the language modules should only need to pass the blobs to translate where appropriate. The less I have to fiddle with the individual language modules, the better, I believe

Rest of this will be tomorrow! Manyana Manyana Manyana.
Extra thanks to Olly for informing me all of my post titles were based around the wrong month :-) Oops…

Arrival Haikou, Got Payment!

bhy — Mon, 21 Jul 2008 20:22:00 +0200

First, I have arrival Haikou tonight, and then have eaten some delicious. :)

Secondly, the GSoC payment has sent to my store value card right now! Hopefully every GSoCers have got it. :)

Update July 20

cmfoil — Mon, 21 Jul 2008 08:08:38 +0200

Spent today doing a few tweaks then more SWIG code review and a lot of reading through some documentation. Instead of my previous “beat SWIG with a stick until it does something” attempts, I’m going to lay out a very technical plan tomorrow. Running it by Olly and hopefully some other SWIG mentors should be a good way to ensure that its actually feasible- and it’s always good to make sure what I believe is the desired functionality… is actually the desired functionality ;) Would be very nice to set out with a good design. I also need to look up a bit more on some things like using error numbers and such so I can develop for SWIG properly.
I also need to figure out what modules are going to want the option to have doxygen, and how best to deal with that.

Back!

bhy — Mon, 21 Jul 2008 05:22:00 +0200

Well, finally I have came back to the earth!

After a super busy month, many things get done - the exams, TOEFL, GSoC midterm evaluation, rent room in Singapore, … Another good news is my GSoC project still on track! Though, well, I have a little trouble of implementing the Python buffer support - I havn’t a clear plan about what I am going to do…

Tonight I will go to Haikou, and then contiune my summer in this hot beatiful city. :)

Update July 19

cmfoil — Sun, 20 Jul 2008 08:50:23 +0200

(output from the latest build of mine)
---ORIGINAL DOXYGEN--- //! A normal member taking two arguments and returning an integer value. This is a very long description for the simple purpose of showing off formatting. Let's make it a bit longer just to be sure. /*! \param a an \b integer argument. \return The test results \param s a constant character pointer. Let's also make this a very long description! \bug this command should, for now, be totally ignored \author cheryl foil \sa Test(), ~Test(), testMeToo() and publicVar() */
---RESULT IN JAVADOC--- /** * A normal member taking two arguments and returning an integer value. * This is a very long description for the simple purpose of showing * off formatting. Let's make it a bit longer just to be sure. * * @author cheryl foil * @param s a constant character pointer. Let's also make this a very * long description! * @param a an <b>integer</b> argument. * @return The test results * @see Test(), ~Test(), testMeToo() and publicVar() */
(long description is actually in line with “s”, not @param)
Hurray! There are quite a few other tags I would like to add in (mostly that pertain to HTML)- and autobrief is still not dealt with in the parser. However, the usual javaDoc-pertinent tags are functional! I feel it would be better for me to work through the SWIG section now- especially since some people seem to be a fan of having an option to just put in the unprocessed doxygen. :) I spent a good bit of today poking at SWIG to begin my brainstorming. I think tomorrow is going to be the start of a very intense week! It’s good timing though, my entire family about to leave for a week long trip, so none of the usual obligations will be around!

Update July 18

cmfoil — Sat, 19 Jul 2008 07:51:33 +0200

(Holding to my promise to update no matter what!)
Didn’t manage to get to much done today due to my boyfriend’s birthday :) Had to leave the house much earlier than I expected! Just means I’ll have to work a bit more tomorrow though.
Few things for me to remember:
-Olly brought up using Google code base to find Doxygen comments to use for examples… must remember to do this!
-Wsfulton brought up attempting to grab any c/c++ comments and putting them without modification into the proxy file, should look in to the best way to catch them
-figure out a good way to catch comments placed after what they are defining (I’m still going to call them “Side comments” for now since there’s no official word. >.<”) such as /**< enum value 2 */