Re: [Lynx-dev] Developer Documentation

[Thomas Dickey]

On Wed, 20 Jun 2007, Amir Shehzad Malik wrote:

> Thanks for your reply.... well yes.. It is to be cross compiled.... Thats
> ok but now can you suggest some document to understand the code
> organization so I can get going with the code a little faster...

not really.  Here's a quick overview. The configure script and makefiles 
know about 3 directories:

WWW/Library/Implementation
src
src/chrtrans

The WWW tree was originally the w3c library.  That's where the networking 
is done, the SGML parsing done.  Over in src are the HTML parsing (on top 
of the SGML) and the layout onto the screen.  src/chrtrans builds the 
compiled-in character-set tables used to make approximations to different 
types of display.  Many of the localized messages are defined in the
top-level LYMessages_en.h

The configure script (--help) and INSTALLATION files document lynx from 
the standpoint of building and installing.  For _modifying_ the code, 
there's no concise description.  When I'm making changes to it, having a 
general sense of where things are helps.  Also, running "lynx -trace" logs 
a lot of information to $HOME/Lynx.trace (and grep'ing for strings from 
the trace file does help find things).

I'd expect you'll make changes to accommodate networking quirks, e.g,
in WWW/Library/Implementation/www_tcp.h (which, along with HTUtils.h) is 
one of the principal places that platform-tweaks are made.  The ones that 
can be derived from a configure-script check are of course made there...

> Thanks
>
> ________________________________________________________________________________
> From:  Thomas Dickey <address@hidden>
> To:  Malik Aamir Shehzad <address@hidden>
> CC:  address@hidden
> Subject:  Re: [Lynx-dev] Developer Documentation
> Date:  Wed, 20 Jun 2007 07:40:03 -0400 (EDT)
> >On Wed, 20 Jun 2007, Malik Aamir Shehzad wrote:
> >
> >>Hi .... I am working on a project to port Lynx to Trimedia (an
> >>embedded system plateform).... I am complete beginner with
> Lynx...
> >>I have its code and now I want to know how and where should I
> start
> >>to understand the code.. Can I get some help regarding this or
> can
> >>I obtain developer documentation from somewhere?
> >
> >The files in the source-tree are about all the documentation that
> >exists.
> >Since it's an embedded system, I'd assume you're going to
> >cross-compile.
> >Lynx's configure script might work for that - I made some changes
> a
> >few
> >years ago to allow the utility in src/chrtrans to be built/run
> with
> >the
> >build-machine's compiler, but don't have a cross-development
> >environment that can build the whole application.  (I did some of
> >this using a djgpp cross-compiler that is able to build ncurses).
> >
> >Besides lynx, you'll need something like ncurses (even slang).
> >
> >Best thing to do is to build a copy on a machine that's easy to
> >build on, i.e., no cross-compiling, and see what the pieces are.
> >
> >--
> >Thomas E. Dickey
> >http://invisible-island.net
> >ftp://invisible-island.net
> >
> >
> >_______________________________________________
> >Lynx-dev mailing list
> >address@hidden
> >http://lists.nongnu.org/mailman/listinfo/lynx-dev
>
>
> ________________________________________________________________________________
> Express yourself instantly with MSN Messenger! MSN Messenger Download
> today it's FREE!

--
Thomas E. Dickey
http://invisible-island.net
ftp://invisible-island.net