2010-02-06T12:50:25Z

Hns: /* Source Code */

=== SimpleWebKit ===

== Background Information ==

* originated in mySTEP
* is completely written in Objective-C (1.0) so that it can be compiled on any system, even with gcc 2.95.3
* aims at providing the most popular documented methods of Full WebKit for the classes WebView, WebFrame, WebDataSource, etc.
* aims at rendering (X)HTML as well as possible (but not perfectly)
* uses NSAttributedStrings passed into NSTextView as the rendering backend
* already displays many pages
* is used in the [[Vespucci.app]] Web Browser application for GNUstep

== Source Code ==

svn co http://svn.gna.org/svn/gnustep/libs/simplewebkit/trunk

svn+ssh://user@svn.gna.org/svn/gnustep/libs/simplewebkit/trunk

http://svn.gna.org/viewcvs/gnustep/libs/simplewebkit/trunk

== How to compile ==

mkdir SWK
cd SWK
svn co http://svn.gna.org/svn/gnustep/libs/simplewebkit/trunk
cd trunk
make

== Status ==

Features of the Subversion (SVN) trunk code:
* parses (X)HTML into a DOM tree
* renders approx. 98% of the HTML 4.0 tags in a reasonable way (e.g. < font color="#667788">, < center>, < h2>, works)
* makes <a> links clickable and processes them
* loads <img>
* loads <script> etc. asynchronously i.e. loads them as subresources
* loads CSS etc. asynchronously i.e. loads them as subresources
* handles <frame>
* handles <form>
* handles < table > (if the NSTextView backend can handle)
* has an ECMAScript engine that parses 90% of the syntax and evaluates expressions (missing are Statements and the native Objects including "document", "window", "event" etc.)

Missing:
* properly compile and run <script>
* completion of the ECMAScript engine
* properly parse and apply CSS

== SWK Browser ==

SWK Browser is part of the SimpleWebKit project and more or less a test bed for it, although it has most features of a full browser.
These are
* multiple documents
* shows (X)HTML, Images etc.
* can show page source code
* can show activities (i.e. subresources)
* can show a DOM Tree inspector
* has a JavaScript console

We have compiled Simple WebKit and SWK Browser with Cocoa so that it runs natively on a Mac.

Download it here: [http://www.quantum-step.com/download/SWKBrowser.app.zip]

== Screenshots ==

Some first screen shots (made from SWK Browser on a Mac)

[[Image:SimpleWebKit_Example_1.png]]

== How it Works ==

1. the WebView
* is the master view object and there is only one per browser (or browser tab)
* it holds the mainFrame which represents either the normal <body> or the top level <frame> or <frameset>
* if there is a <frameset> hierarchy, there are additional child WebFrames

2. the WebFrame
* is repsonsible for loading and rendering content from a specific URL
* it uses a WebDataSource to trigger loading and get callbacks
* it is also the owner of the DOMDocument tree
* JavaScript statements are evaluated in a frame context
* it is also the target of user clicks on links since it knows the base URL (through the WebDataSource)

3. the WebDataSource
* is responsible for loading data from an URL
* it may cache data and handle/synchronize loading fo subresources (e.g. for an embedded <img> tag)
* it translates the request and the response URLs
* it provides an estimated content length (for a progress indicator) and the MIMEType of the incoming data stream
* as soon as the header comes in a WebDocomentRepresentation is created and incoming segments are notified
* it also collects the incoming data, so that a WebDocumentRepresentation can handle either segments or the collected data

4. the WebDocumentRepresentation(s)
* there is one for each MIME type (the WebView provides a mapping database)
* it is responsible for parsing the incoming data stream (either completely when finished, or partially)
* and provide a better suitable representation, e.g. an NSImage or a DOMHTMLTree
* finally, it creates a WebDocumentView as the child of the WebView and attaches it to the WebFrame as the -webFrameView
* so, if you want to handle an additional MIME type, write a class that conforms to the WebDocumentRepresentation protocol

5. NSXMLParser
* a private variant is used that adds a stalling mechanism and selection of the file encoding
* recognizes the <?xml> tag for XHTML and has a lazy mode for pure HTML
* it also has an Entity table that translates the HTML entities to character strings

6. the DOMHTMLTree
* is used only for HTML content
* is built in WebHTMLDocumentRepresentation by parsing segment of HTML data coming in
* any change in the DOMHTMLTree is notified to the WebDocumentView (or one of its subviews) by setNeedsLayout
* each class of potential DOMHTMLTree records has methods to denote how to handle tags
* the tag to class mapping is table driven

7. the WebDocumentView(s) an its subviews
* are responsible for displaying the contents of its WebDataRepresentation
* either HTML, Images, PDF or whatever (e.g. SVG, XML, ...)
* they gets notified about changes either by updates of the WebDataSource (-dadaSourceUpdated:) or directly (-setNeedsLayout:)
* if one needs layout, it must go to the DOM Tree to find out what has changed and update its size, content, children, layout etc.
* this is a little tricky/risky since the -layout method is called within -drawRect: - so changing e.g. the View frame is very critical and may result in drawing glitches
* for HTML, we do a simple trick: the WebDocumentView is an NSTextView and the DOMHTMLTree objects can be traversed to return an attributedString with embedded Tables and NSTextAttachments

8. the JavaScript engine
* is programmed according to the specificaion of [[http://www.ecma-international.org/publications/standards/Ecma-262.htm] ECMA-262]
* uses a simple recursive stateless parser (could be optimized in stack useage and speed by a state-table driven approach)
* parses the script into a Tree representation in a first step
* then, evaluates the expressions and statements according to the current environement
* this allows to store scripts in translated form and reevaluate them when needed (e.g. on mouse events)
* uses Foundation for basic types (string, number, boolean, null)
* uses WebScriptObject as the base Object representation
* DOMObjects are a subclass of WebScriptObjects and therefore provide bridging, so that changing a DOMHTML tree element through JavaScript automatically triggers the appropriate WebDocumentView update notification

9. the CSS engine
* CSS style sheets are translated into a DOMCSS tree
* @import ed sheets are loaded as needed
* the CSS is not yet applied to the HTML -> NSAttributedString translation

== Contact ==

Author: Nikolaus Schaller
QuantumSTEP: http://www.quantum-step.com

Category:FOSDEM

2010-01-18T07:05:45Z

Hns:

Category:FOSDEM

2010-01-18T07:05:29Z

Hns:

SimpleWebKit

2010-01-13T12:47:48Z

Hns: /* How it Works */

=== SimpleWebKit ===

== Background Information ==

* originated in mySTEP
* is completely written in Objective-C (1.0) so that it can be compiled on any system, even with gcc 2.95.3
* aims at providing the most popular documented methods of Full WebKit for the classes WebView, WebFrame, WebDataSource, etc.
* aims at rendering (X)HTML as well as possible (but not perfectly)
* uses NSAttributedStrings passed into NSTextView as the rendering backend
* already displays many pages
* is used in the [[Vespucci.app]] Web Browser application for GNUstep

== Source Code ==

svn+ssh://user@svn.gna.org/svn/gnustep/libs/simplewebkit/trunk

http://svn.gna.org/viewcvs/gnustep/libs/simplewebkit/trunk

== Status ==

Features of the Subversion (SVN) trunk code:
* parses (X)HTML into a DOM tree
* renders approx. 98% of the HTML 4.0 tags in a reasonable way (e.g. < font color="#667788">, < center>, < h2>, works)
* makes <a> links clickable and processes them
* loads <img>
* loads <script> etc. asynchronously i.e. loads them as subresources
* loads CSS etc. asynchronously i.e. loads them as subresources
* handles <frame>
* handles <form>
* handles < table > (if the NSTextView backend can handle)
* has an ECMAScript engine that parses 90% of the syntax and evaluates expressions (missing are Statements and the native Objects including "document", "window", "event" etc.)

Missing:
* properly compile and run <script>
* completion of the ECMAScript engine
* properly parse and apply CSS

== SWK Browser ==

SWK Browser is part of the SimpleWebKit project and more or less a test bed for it, although it has most features of a full browser.
These are
* multiple documents
* shows (X)HTML, Images etc.
* can show page source code
* can show activities (i.e. subresources)
* can show a DOM Tree inspector
* has a JavaScript console

We have compiled Simple WebKit and SWK Browser with Cocoa so that it runs natively on a Mac.

Download it here: [http://www.quantum-step.com/download/SWKBrowser.app.zip]

== Screenshots ==

Some first screen shots (made from SWK Browser on a Mac)

[[Image:SimpleWebKit_Example_1.png]]

== How it Works ==

1. the WebView
* is the master view object and there is only one per browser (or browser tab)
* it holds the mainFrame which represents either the normal <body> or the top level <frame> or <frameset>
* if there is a <frameset> hierarchy, there are additional child WebFrames

2. the WebFrame
* is repsonsible for loading and rendering content from a specific URL
* it uses a WebDataSource to trigger loading and get callbacks
* it is also the owner of the DOMDocument tree
* JavaScript statements are evaluated in a frame context
* it is also the target of user clicks on links since it knows the base URL (through the WebDataSource)

3. the WebDataSource
* is responsible for loading data from an URL
* it may cache data and handle/synchronize loading fo subresources (e.g. for an embedded <img> tag)
* it translates the request and the response URLs
* it provides an estimated content length (for a progress indicator) and the MIMEType of the incoming data stream
* as soon as the header comes in a WebDocomentRepresentation is created and incoming segments are notified
* it also collects the incoming data, so that a WebDocumentRepresentation can handle either segments or the collected data

4. the WebDocumentRepresentation(s)
* there is one for each MIME type (the WebView provides a mapping database)
* it is responsible for parsing the incoming data stream (either completely when finished, or partially)
* and provide a better suitable representation, e.g. an NSImage or a DOMHTMLTree
* finally, it creates a WebDocumentView as the child of the WebView and attaches it to the WebFrame as the -webFrameView
* so, if you want to handle an additional MIME type, write a class that conforms to the WebDocumentRepresentation protocol

5. NSXMLParser
* a private variant is used that adds a stalling mechanism and selection of the file encoding
* recognizes the <?xml> tag for XHTML and has a lazy mode for pure HTML
* it also has an Entity table that translates the HTML entities to character strings

6. the DOMHTMLTree
* is used only for HTML content
* is built in WebHTMLDocumentRepresentation by parsing segment of HTML data coming in
* any change in the DOMHTMLTree is notified to the WebDocumentView (or one of its subviews) by setNeedsLayout
* each class of potential DOMHTMLTree records has methods to denote how to handle tags
* the tag to class mapping is table driven

7. the WebDocumentView(s) an its subviews
* are responsible for displaying the contents of its WebDataRepresentation
* either HTML, Images, PDF or whatever (e.g. SVG, XML, ...)
* they gets notified about changes either by updates of the WebDataSource (-dadaSourceUpdated:) or directly (-setNeedsLayout:)
* if one needs layout, it must go to the DOM Tree to find out what has changed and update its size, content, children, layout etc.
* this is a little tricky/risky since the -layout method is called within -drawRect: - so changing e.g. the View frame is very critical and may result in drawing glitches
* for HTML, we do a simple trick: the WebDocumentView is an NSTextView and the DOMHTMLTree objects can be traversed to return an attributedString with embedded Tables and NSTextAttachments

8. the JavaScript engine
* is programmed according to the specificaion of [[http://www.ecma-international.org/publications/standards/Ecma-262.htm] ECMA-262]
* uses a simple recursive stateless parser (could be optimized in stack useage and speed by a state-table driven approach)
* parses the script into a Tree representation in a first step
* then, evaluates the expressions and statements according to the current environement
* this allows to store scripts in translated form and reevaluate them when needed (e.g. on mouse events)
* uses Foundation for basic types (string, number, boolean, null)
* uses WebScriptObject as the base Object representation
* DOMObjects are a subclass of WebScriptObjects and therefore provide bridging, so that changing a DOMHTML tree element through JavaScript automatically triggers the appropriate WebDocumentView update notification

9. the CSS engine
* CSS style sheets are translated into a DOMCSS tree
* @import ed sheets are loaded as needed
* the CSS is not yet applied to the HTML -> NSAttributedString translation

== Contact ==

Author: Nikolaus Schaller
QuantumSTEP: http://www.quantum-step.com

SimpleWebKit

2010-01-13T12:45:37Z

Hns: /* Status */

=== SimpleWebKit ===

== Background Information ==

* originated in mySTEP
* is completely written in Objective-C (1.0) so that it can be compiled on any system, even with gcc 2.95.3
* aims at providing the most popular documented methods of Full WebKit for the classes WebView, WebFrame, WebDataSource, etc.
* aims at rendering (X)HTML as well as possible (but not perfectly)
* uses NSAttributedStrings passed into NSTextView as the rendering backend
* already displays many pages
* is used in the [[Vespucci.app]] Web Browser application for GNUstep

== Source Code ==

svn+ssh://user@svn.gna.org/svn/gnustep/libs/simplewebkit/trunk

http://svn.gna.org/viewcvs/gnustep/libs/simplewebkit/trunk

== Status ==

Features of the Subversion (SVN) trunk code:
* parses (X)HTML into a DOM tree
* renders approx. 98% of the HTML 4.0 tags in a reasonable way (e.g. < font color="#667788">, < center>, < h2>, works)
* makes <a> links clickable and processes them
* loads <img>
* loads <script> etc. asynchronously i.e. loads them as subresources
* loads CSS etc. asynchronously i.e. loads them as subresources
* handles <frame>
* handles <form>
* handles < table > (if the NSTextView backend can handle)
* has an ECMAScript engine that parses 90% of the syntax and evaluates expressions (missing are Statements and the native Objects including "document", "window", "event" etc.)

Missing:
* properly compile and run <script>
* completion of the ECMAScript engine
* properly parse and apply CSS

== SWK Browser ==

SWK Browser is part of the SimpleWebKit project and more or less a test bed for it, although it has most features of a full browser.
These are
* multiple documents
* shows (X)HTML, Images etc.
* can show page source code
* can show activities (i.e. subresources)
* can show a DOM Tree inspector
* has a JavaScript console

We have compiled Simple WebKit and SWK Browser with Cocoa so that it runs natively on a Mac.

Download it here: [http://www.quantum-step.com/download/SWKBrowser.app.zip]

== Screenshots ==

Some first screen shots (made from SWK Browser on a Mac)

[[Image:SimpleWebKit_Example_1.png]]

== How it Works ==

1. the WebView
* is the master view object and there is only one per browser (or browser tab)
* it holds the mainFrame which represents either the normal <body> or the top level <frame> or <frameset>
* if there is a <frameset> hierarchy, there are additional child WebFrames

2. the WebFrame
* is repsonsible for loading and rendering content from a specific URL
* it uses a WebDataSource to trigger loading and get callbacks
* it is also the owner of the DOMDocument tree
* JavaScript statements are evaluated in a frame context
* it is also the target of user clicks on links since it knows the base URL (through the WebDataSource)

3. the WebDataSource
* is responsible for loading data from an URL
* it may cache data and handle/synchronize loading fo subresources (e.g. for an embedded <img> tag)
* it translates the request and the response URLs
* it provides an estimated content length (for a progress indicator) and the MIMEType of the incoming data stream
* as soon as the header comes in a WebDocomentRepresentation is created and incoming segments are notified
* it also collects the incoming data, so that a WebDocumentRepresentation can handle either segments or the collected data

4. the WebDocumentRepresentation(s)
* there is one for each MIME type (the WebView provides a mapping database)
* it is responsible for parsing the incoming data stream (either completely when finished, or partially)
* and provide a better suitable representation, e.g. an NSImage or a DOMHTMLTree
* finally, it creates a WebDocumentView as the child of the WebView and attaches it to the WebFrame as the -webFrameView
* so, if you want to handle an additional MIME type, write a class that conforms to the WebDocumentRepresentation protocol

5. NSXMLParser
* a private variant is used that adds a stalling mechanism and selection of the file encoding
* recognizes the <?xml> tag for XHTML and has a lazy mode for pure HTML
* it also has an Entity table that translates the HTML entities to character strings

6. the DOMHTMLTree
* is used only for HTML content
* is built in WebHTMLDocumentRepresentation by parsing segment of HTML data coming in
* any change in the DOMHTMLTree is notified to the WebDocumentView (or one of its subviews) by setNeedsLayout
* each class of potential DOMHTMLTree records has methods to denote how to handle tags
* the tag to class mapping is table driven

7. the WebDocumentView(s) an its subviews
* are responsible for displaying the contents of its WebDataRepresentation
* either HTML, Images, PDF or whatever (e.g. SVG, XML, ...)
* they gets notified about changes either by updates of the WebDataSource (-dadaSourceUpdated:) or directly (-setNeedsLayout:)
* if one needs layout, it must go to the DOM Tree to find out what has changed and update its size, content, children, layout etc.
* this is a little tricky/risky since the -layout method is called within -drawRect: - so changing e.g. the View frame is very critical and may result in drawing glitches
* for HTML, we do a simple trick: the WebDocumentView is an NSTextView and the DOMHTMLTree objects can be traversed to return an attributedString with embedded Tables and NSTextAttachments

8. the JavaScript engine
* is programmed according to the specificaion of [[http://www.ecma-international.org/publications/standards/Ecma-262.htm] ECMA-262]
* uses a simple recursive stateless parser (could be optimized in stack useage and speed by a state-table driven approach)
* parses the script into a Tree representation in a first step
* then, evaluates the expressions and statements according to the current environement
* this allows to store scripts in translated form and reevaluate them when needed (e.g. on mouse events)
* uses Foundation for basic types (string, number, boolean, null)
* uses WebScriptObject as the base Object representation
* DOMObjects are a subclass of WebScriptObjects and therefore provide bridging, so that changing a DOMHTML tree element through JavaScript automativally triggers the appropriate WebDocumentView notification

9. the CSS engine
* has to be written
* shall have three components: CSS database, CSS parser, CSS evaluator

== Contact ==

Author: Nikolaus Schaller
QuantumSTEP: http://www.quantum-step.com

SimpleWebKit

2010-01-13T12:45:12Z

Hns: /* Status */

=== SimpleWebKit ===

== Background Information ==

* originated in mySTEP
* is completely written in Objective-C (1.0) so that it can be compiled on any system, even with gcc 2.95.3
* aims at providing the most popular documented methods of Full WebKit for the classes WebView, WebFrame, WebDataSource, etc.
* aims at rendering (X)HTML as well as possible (but not perfectly)
* uses NSAttributedStrings passed into NSTextView as the rendering backend
* already displays many pages
* is used in the [[Vespucci.app]] Web Browser application for GNUstep

== Source Code ==

svn+ssh://user@svn.gna.org/svn/gnustep/libs/simplewebkit/trunk

http://svn.gna.org/viewcvs/gnustep/libs/simplewebkit/trunk

== Status ==

Features of the Subversion (SVN) trunk code:
* parses (X)HTML into a DOM tree
* renders approx. 98% of the HTML 4.0 tags in a reasonable way (e.g. < font color="#667788">, < center>, < h2>, works)
* makes <a> links clickable and processes them
* loads <img>
* loads <script> etc. asynchronously i.e. loads them as subresources
* loads CSS etc. asynchronously i.e. loads them as subresources
* handles <frame>
* handles <form>
* handles <table> (if the NSTextView backend can handle)
* has an ECMAScript engine that parses 90% of the syntax and evaluates expressions (missing are Statements and the native Objects including "document", "window", "event" etc.)

Missing:
* properly compile and run <script>
* completion of the ECMAScript engine
* properly parse and apply CSS

== SWK Browser ==

SWK Browser is part of the SimpleWebKit project and more or less a test bed for it, although it has most features of a full browser.
These are
* multiple documents
* shows (X)HTML, Images etc.
* can show page source code
* can show activities (i.e. subresources)
* can show a DOM Tree inspector
* has a JavaScript console

We have compiled Simple WebKit and SWK Browser with Cocoa so that it runs natively on a Mac.

Download it here: [http://www.quantum-step.com/download/SWKBrowser.app.zip]

== Screenshots ==

Some first screen shots (made from SWK Browser on a Mac)

[[Image:SimpleWebKit_Example_1.png]]

== How it Works ==

1. the WebView
* is the master view object and there is only one per browser (or browser tab)
* it holds the mainFrame which represents either the normal <body> or the top level <frame> or <frameset>
* if there is a <frameset> hierarchy, there are additional child WebFrames

2. the WebFrame
* is repsonsible for loading and rendering content from a specific URL
* it uses a WebDataSource to trigger loading and get callbacks
* it is also the owner of the DOMDocument tree
* JavaScript statements are evaluated in a frame context
* it is also the target of user clicks on links since it knows the base URL (through the WebDataSource)

3. the WebDataSource
* is responsible for loading data from an URL
* it may cache data and handle/synchronize loading fo subresources (e.g. for an embedded <img> tag)
* it translates the request and the response URLs
* it provides an estimated content length (for a progress indicator) and the MIMEType of the incoming data stream
* as soon as the header comes in a WebDocomentRepresentation is created and incoming segments are notified
* it also collects the incoming data, so that a WebDocumentRepresentation can handle either segments or the collected data

4. the WebDocumentRepresentation(s)
* there is one for each MIME type (the WebView provides a mapping database)
* it is responsible for parsing the incoming data stream (either completely when finished, or partially)
* and provide a better suitable representation, e.g. an NSImage or a DOMHTMLTree
* finally, it creates a WebDocumentView as the child of the WebView and attaches it to the WebFrame as the -webFrameView
* so, if you want to handle an additional MIME type, write a class that conforms to the WebDocumentRepresentation protocol

5. NSXMLParser
* a private variant is used that adds a stalling mechanism and selection of the file encoding
* recognizes the <?xml> tag for XHTML and has a lazy mode for pure HTML
* it also has an Entity table that translates the HTML entities to character strings

6. the DOMHTMLTree
* is used only for HTML content
* is built in WebHTMLDocumentRepresentation by parsing segment of HTML data coming in
* any change in the DOMHTMLTree is notified to the WebDocumentView (or one of its subviews) by setNeedsLayout
* each class of potential DOMHTMLTree records has methods to denote how to handle tags
* the tag to class mapping is table driven

7. the WebDocumentView(s) an its subviews
* are responsible for displaying the contents of its WebDataRepresentation
* either HTML, Images, PDF or whatever (e.g. SVG, XML, ...)
* they gets notified about changes either by updates of the WebDataSource (-dadaSourceUpdated:) or directly (-setNeedsLayout:)
* if one needs layout, it must go to the DOM Tree to find out what has changed and update its size, content, children, layout etc.
* this is a little tricky/risky since the -layout method is called within -drawRect: - so changing e.g. the View frame is very critical and may result in drawing glitches
* for HTML, we do a simple trick: the WebDocumentView is an NSTextView and the DOMHTMLTree objects can be traversed to return an attributedString with embedded Tables and NSTextAttachments

8. the JavaScript engine
* is programmed according to the specificaion of [[http://www.ecma-international.org/publications/standards/Ecma-262.htm] ECMA-262]
* uses a simple recursive stateless parser (could be optimized in stack useage and speed by a state-table driven approach)
* parses the script into a Tree representation in a first step
* then, evaluates the expressions and statements according to the current environement
* this allows to store scripts in translated form and reevaluate them when needed (e.g. on mouse events)
* uses Foundation for basic types (string, number, boolean, null)
* uses WebScriptObject as the base Object representation
* DOMObjects are a subclass of WebScriptObjects and therefore provide bridging, so that changing a DOMHTML tree element through JavaScript automativally triggers the appropriate WebDocumentView notification

9. the CSS engine
* has to be written
* shall have three components: CSS database, CSS parser, CSS evaluator

== Contact ==

Author: Nikolaus Schaller
QuantumSTEP: http://www.quantum-step.com

FOSDEM 2010

2010-01-11T12:17:42Z

2010-01-03T10:50:02Z

Hns: /* Current Version: [ftp://ftp.gnustep.org/pub/gnustep/libs/tbd] */

GNUstep Core Data

THIS IS A STUB - PLEASE UPDATE.

==== Current Version: [ftp://ftp.gnustep.org/pub/gnustep/libs/tbd] ====
* http://www.gnustep.org/softwareindex/showdetail.php?app=94
* http://svn.gna.org/viewcvs/gnustep/libs/gscoredata/
* Released tbc.

=== Features ===

GSCoreData consists of the following components:

* GSCoreData.framework
: The fundamental library

* DataBuilder.app
: This tool allows to edit entity-relations

=== State ===

Not yet complete. DataBuilder works (also on MacOS X).

=== Maintainer ===

* [mailto:tbd tbd]

[[Category:Database Frameworks]]
[[Category:Frameworks]]

GSCoreData

2010-01-03T10:49:23Z

Hns: /* State */

GNUstep Core Data

THIS IS A STUB - PLEASE UPDATE.

==== Current Version: [ftp://ftp.gnustep.org/pub/gnustep/libs/tbd] ====
* http://svn.gna.org/viewcvs/gnustep/libs/gscoredata/
* Released tbc.

=== Features ===

GSCoreData consists of the following components:

* GSCoreData.framework
: The fundamental library

* DataBuilder.app
: This tool allows to edit entity-relations

=== State ===

Not yet complete. DataBuilder works (also on MacOS X).

=== Maintainer ===

* [mailto:tbd tbd]

[[Category:Database Frameworks]]
[[Category:Frameworks]]

GSCoreData

2010-01-03T10:49:09Z

Hns: /* Features */

GNUstep Core Data

THIS IS A STUB - PLEASE UPDATE.

==== Current Version: [ftp://ftp.gnustep.org/pub/gnustep/libs/tbd] ====
* http://svn.gna.org/viewcvs/gnustep/libs/gscoredata/
* Released tbc.

=== Features ===

GSCoreData consists of the following components:

* GSCoreData.framework
: The fundamental library

* DataBuilder.app
: This tool allows to edit entity-relations

=== State ===

Not yet complete. DataBuilder works (also on on MacOS X).

=== Maintainer ===

* [mailto:tbd tbd]

[[Category:Database Frameworks]]
[[Category:Frameworks]]

GSCoreData

2010-01-03T10:48:54Z

Summer Of Code 2009

2009-03-06T07:20:14Z

Hns: /* Ideas */

== Summer Of Code 2009 ==

The [http://code.google.com/soc/ Summer Of Code] is a Google program that offers student developers stipends to create new freely available programs or to help currently established projects. It would be an excellent opportunity for GNUstep to fund some developments.

=== Joint Application? ===

The idea of a joint application for GNUstep, Étoilé, GAP and opengroupware.org has been brought up. A lot of the projects that were accepted last year were joint applications (e.g. GNU, GNOME, KDE), so it might improve our chances. Please discuss!

=== Ideas ===

Here are some ideas -- Feel free to add more

* '''Porting'''
** Porting [http://developer.apple.com/opensource/internet/webkit.html WebKit] (using GCC 4.x with ObjC++ support) should be a lot easier by now (see http://lwat.blogspot.com/2008/11/redistributable-webkit.html and http://lwat.blogspot.com/2009/02/opencflite-476171-release.html)
** helping to improve Simple WebKit which does not require gcc 4.xx and Obj-C++ and has less dependencies and a much smaller footprint than full WebKit

* '''General Improvements'''
** Windows support
** GNUstepWeb (add script language support, etc)
** Compare current API with Leopard's (Mac OS X 10.5) API, indicate which classes are missing, and summarize the current status of the existing ones, then work to complete them... ;) The best would be to have a tool which parses all headers (both from Cocoa and GNUstep) and outputs differences in HTML (XML probably too by the way). This would summarize missing classes, missing or partially implementated methods in existing classes and GNUstep-specific extensions. Eventually we should include links to the related documentation on both GNUstep and Cocoa web sites.

* '''AppKit'''

* '''Base'''

* '''Misc'''
** Create a AJAX Framework for GNUstepWeb (similar to what [http://wiki.objectstyle.org/confluence/display/WO/Project+WONDER-Overview Project Wonder] [http://en.wikibooks.org/wiki/Programming:WebObjects/Project_WONDER/Frameworks/Ajax provides for WebObjects]

* '''More Ideas'''
** [[Summer Of Code Ideas]]

=== Note ===

We need [http://code.google.com/soc/mentorfaq.html mentor(s)] to manage the volunteers...

=== Mentors ===

- t.b.a.

=== Students ===

- t.b.a.

Summer Of Code 2009

2009-03-06T07:19:29Z

Hns: /* Ideas */

== Summer Of Code 2009 ==

The [http://code.google.com/soc/ Summer Of Code] is a Google program that offers student developers stipends to create new freely available programs or to help currently established projects. It would be an excellent opportunity for GNUstep to fund some developments.

=== Joint Application? ===

The idea of a joint application for GNUstep, Étoilé, GAP and opengroupware.org has been brought up. A lot of the projects that were accepted last year were joint applications (e.g. GNU, GNOME, KDE), so it might improve our chances. Please discuss!

=== Ideas ===

Here are some ideas -- Feel free to add more

* '''Porting'''
** Porting [http://developer.apple.com/opensource/internet/webkit.html WebKit] (using GCC 4.x with ObjC++ support) should be a lot easier by now (see http://lwat.blogspot.com/2008/11/redistributable-webkit.html and http://lwat.blogspot.com/2009/02/opencflite-476171-release.html)
** helping to improve Simple WebKit which does not require gcc 4.xx and Obj-C++ and has a much smaller footprint

* '''General Improvements'''
** Windows support
** GNUstepWeb (add script language support, etc)
** Compare current API with Leopard's (Mac OS X 10.5) API, indicate which classes are missing, and summarize the current status of the existing ones, then work to complete them... ;) The best would be to have a tool which parses all headers (both from Cocoa and GNUstep) and outputs differences in HTML (XML probably too by the way). This would summarize missing classes, missing or partially implementated methods in existing classes and GNUstep-specific extensions. Eventually we should include links to the related documentation on both GNUstep and Cocoa web sites.

* '''AppKit'''

* '''Base'''

* '''Misc'''
** Create a AJAX Framework for GNUstepWeb (similar to what [http://wiki.objectstyle.org/confluence/display/WO/Project+WONDER-Overview Project Wonder] [http://en.wikibooks.org/wiki/Programming:WebObjects/Project_WONDER/Frameworks/Ajax provides for WebObjects]

* '''More Ideas'''
** [[Summer Of Code Ideas]]

=== Note ===

We need [http://code.google.com/soc/mentorfaq.html mentor(s)] to manage the volunteers...

=== Mentors ===

- t.b.a.

=== Students ===

- t.b.a.

Platform:Linux

2009-02-24T09:52:26Z

Hns: /* Install from source: Dependencies */

{{stub}}

== Debian / Ubuntu ==
=== Debian ===
Since Debian ''Sarge'' (3.1) you can use '''apt-get''' to obtain GNUstep packages.

# apt-get install x-window-system-core wmaker gnustep gnustep-devel gnustep-games

to install GNUstep, X11 and Window Maker.

The best way to get up-to-date GNUstep packages is to upgrade from ''stable'' to ''testing'' or ''unstable''. If upgrading to Debian ''unstable'' is not desirable it is possible to simply add the unstable apt lines to the sources.list and specify the distribution when installing the packages, e.g.
# apt-get install -t unstable gnumail.app
This method might upgrade some other packages to satisfy dependencies, but will have a much smaller impact on the system since only the packages on which GNUstep depends will be upgraded.

=== Ubuntu ===
As Ubuntu is Debian-based you can likewise install gnustep libraries (and their dependencies) via
sudo apt-get install gnustep gnustep-devel
apt will also suggest a lot of apps to install.

=== Install from source: Dependencies ===
If you want to compile from source install the following [[Dependencies]] packages (applies to both Debian and Ubuntu):

<tt>gobjc, libx11-dev, libx11-xft, libxmu-dev, libtiff4-dev, libpng12-dev, libungif4-dev, libart-2.0-dev, libxml2-dev, libxslt1-dev, libssl-dev, libgmp3-dev, libffcall1-dev</tt> (universe), and <tt>svn</tt> if you want to download the svn version.

Optional: <tt>libaspell-dev</tt> for [[GSspell.service]]

Please follow the instructions on [[GNUstep_SVN_installation_guide]].

== Gentoo ==
To install GNUstep libs and scripts, do
emerge gnustep-env
For a list of GNUstep-related ebuilds, see the [http://packages.gentoo.org/search/?sstring=gnustep Online Package Database].
For the most recent packages, type <code>ACCEPT_KEYWORDS="~x86" emerge <i>package-name</i></code> (or analogically for your cpu family: <tt>"~sparc"</tt>, <tt>"~ppc"</tt> ...)

== Slackware ==

=== Version 10.2 ===
Libraries and accompanying applications will build with no modifications. Slackware 10.2 ships with GCC 3.3.6, so mixed Objective-C and C++ code is not supported, meaning additional frameworks/libraries may not be supported.

=== Version 11.0 ===
This version of Slackware works the same as the previous (10.2). Libraries and applications will build with no modifications, but due to the GCC version used (3.4.6) Objective-C++ is not supported.

=== Version 12.0 ===
GNUstep compiles and install on Slackware 12.0 perfectly. Unfortunately, this version of Slackware does not include an Objective-C++ compiler.

=== Version 12.2 ===
==== Packages ====
Slackware packages have been created and can be found in:
* [ftp://ftp.gnustep.org/pub/gnustep/binaries/slackware/ GNUstep FTP] (Please read gnustep-core.README before installing)
==== Build Scripts ====
SlackBuild scripts can be found at:
* [http://slackbuilds.org/result/?search=gnustep SlackBuilds.org GNUstep scripts]

== SuSE ==
Packages provided by Richard Stonehouse [http://www.rstonehouse.co.uk/extras/gnustep-general/index.html here] (including installation instructions).

[[Category:Development]]

Platform:Linux

2009-02-14T08:01:37Z

Hns: /* Install from source: Dependencies */

{{stub}}

== Debian / Ubuntu ==
=== Debian ===
Since Debian ''Sarge'' (3.1) you can use '''apt-get''' to obtain GNUstep packages.

# apt-get install x-window-system-core wmaker gnustep gnustep-devel gnustep-games

to install GNUstep, X11 and Window Maker.

The best way to get up-to-date GNUstep packages is to upgrade from ''stable'' to ''testing'' or ''unstable''. If upgrading to Debian ''unstable'' is not desirable it is possible to simply add the unstable apt lines to the sources.list and specify the distribution when installing the packages, e.g.
# apt-get install -t unstable gnumail.app
This method might upgrade some other packages to satisfy dependencies, but will have a much smaller impact on the system since only the packages on which GNUstep depends will be upgraded.

=== Ubuntu ===
As Ubuntu is Debian-based you can likewise install gnustep libraries (and their dependencies) via
sudo apt-get install gnustep gnustep-devel
apt will also suggest a lot of apps to install.

=== Install from source: Dependencies ===
If you want to compile from source install the following packages (applies to both Debian and Ubuntu):

<tt>gobjc, libx11-dev, libx11-xft, libxmu-dev, libtiff4-dev, libpng12-dev, libungif4-dev, libart-2.0-dev, libxml2-dev, libxslt1-dev, libssl-dev, libgmp3-dev, libffcall1-dev</tt> (universe), and <tt>svn</tt> if you want to download the svn version.

Optional: <tt>libaspell-dev</tt> for [[GSspell.service]]

Please follow the instructions on [[GNUstep_SVN_installation_guide]].

== Gentoo ==
To install GNUstep libs and scripts, do
emerge gnustep-env
For a list of GNUstep-related ebuilds, see the [http://packages.gentoo.org/search/?sstring=gnustep Online Package Database].
For the most recent packages, type <code>ACCEPT_KEYWORDS="~x86" emerge <i>package-name</i></code> (or analogically for your cpu family: <tt>"~sparc"</tt>, <tt>"~ppc"</tt> ...)

== Slackware ==

=== Version 10.2 ===
Libraries and accompanying applications will build with no modifications. Slackware 10.2 ships with GCC 3.3.6, so mixed Objective-C and C++ code is not supported, meaning additional frameworks/libraries may not be supported.

=== Version 11.0 ===
This version of Slackware works the same as the previous (10.2). Libraries and applications will build with no modifications, but due to the GCC version used (3.4.6) Objective-C++ is not supported.

=== Version 12.0 ===
GNUstep compiles and install on Slackware 12.0 perfectly. Unfortunately, this version of Slackware does not include an Objective-C++ compiler.

=== Version 12.2 ===
==== Packages ====
Slackware packages have been created and can be found in:
* [ftp://ftp.gnustep.org/pub/gnustep/binaries/slackware/ GNUstep FTP] (Please read gnustep-core.README before installing)
==== Build Scripts ====
SlackBuild scripts can be found at:
* [http://slackbuilds.org/result/?search=gnustep SlackBuilds.org GNUstep scripts]

== SuSE ==
Packages provided by Richard Stonehouse [http://www.rstonehouse.co.uk/extras/gnustep-general/index.html here] (including installation instructions).

[[Category:Development]]

Platform:Linux

2009-02-14T07:59:57Z

Hns: edited headings

{{stub}}

== Debian / Ubuntu ==
=== Debian ===
Since Debian ''Sarge'' (3.1) you can use '''apt-get''' to obtain GNUstep packages.

# apt-get install x-window-system-core wmaker gnustep gnustep-devel gnustep-games

to install GNUstep, X11 and Window Maker.

The best way to get up-to-date GNUstep packages is to upgrade from ''stable'' to ''testing'' or ''unstable''. If upgrading to Debian ''unstable'' is not desirable it is possible to simply add the unstable apt lines to the sources.list and specify the distribution when installing the packages, e.g.
# apt-get install -t unstable gnumail.app
This method might upgrade some other packages to satisfy dependencies, but will have a much smaller impact on the system since only the packages on which GNUstep depends will be upgraded.

=== Ubuntu ===
As Ubuntu is Debian-based you can likewise install gnustep libraries (and their dependencies) via
sudo apt-get install gnustep gnustep-devel
apt will also suggest a lot of apps to install.

=== Install from source: Dependencies ===
If you want to compile from source install the following packages (applies to both Debian and Ubuntu):

<tt>gobjc, libx11-dev, libx11-xft, libxmu-dev, libtiff4-dev, libpng12-dev, libungif4-dev, libart-2.0-dev, libxml2-dev, libxslt1-dev, libssl-dev, libgmp3-dev, libffcall1-dev</tt> (universe), and <tt>svn</tt> if you want to download the svn version.

Optional: <tt>libaspell-dev</tt> for [[GSspell.service]]

== Gentoo ==
To install GNUstep libs and scripts, do
emerge gnustep-env
For a list of GNUstep-related ebuilds, see the [http://packages.gentoo.org/search/?sstring=gnustep Online Package Database].
For the most recent packages, type <code>ACCEPT_KEYWORDS="~x86" emerge <i>package-name</i></code> (or analogically for your cpu family: <tt>"~sparc"</tt>, <tt>"~ppc"</tt> ...)

== Slackware ==

=== Version 10.2 ===
Libraries and accompanying applications will build with no modifications. Slackware 10.2 ships with GCC 3.3.6, so mixed Objective-C and C++ code is not supported, meaning additional frameworks/libraries may not be supported.

=== Version 11.0 ===
This version of Slackware works the same as the previous (10.2). Libraries and applications will build with no modifications, but due to the GCC version used (3.4.6) Objective-C++ is not supported.

=== Version 12.0 ===
GNUstep compiles and install on Slackware 12.0 perfectly. Unfortunately, this version of Slackware does not include an Objective-C++ compiler.

=== Version 12.2 ===
==== Packages ====
Slackware packages have been created and can be found in:
* [ftp://ftp.gnustep.org/pub/gnustep/binaries/slackware/ GNUstep FTP] (Please read gnustep-core.README before installing)
==== Build Scripts ====
SlackBuild scripts can be found at:
* [http://slackbuilds.org/result/?search=gnustep SlackBuilds.org GNUstep scripts]

== SuSE ==
Packages provided by Richard Stonehouse [http://www.rstonehouse.co.uk/extras/gnustep-general/index.html here] (including installation instructions).

[[Category:Development]]

Backend

2009-02-06T19:18:41Z

Hns:

{{stub}}

GNUstep's '''backend''' provides a small set of functions used by the [[AppKit|GUI]] library to interface to the actual window system (X11, etc). It also has a drawing engine which emulates common PostScript functions.

The package [[back|gnustep-back]] provides the following backends
* art – default backend on unixlike systems. Uses the vector-based PostScriptlike 2d graphics library libArt.
* winlib – default backend on windows systems. Calls the Windows API.
* xlib – old (deprecated) X11 backend.
* cairo – experimental backend using the cairo 2D graphics library. Whilst being not ready for daily work it is planned to replace the current default backends and let cairo care about the underlying graphics system (xlib/xrender, win32, opengl...)

You can choose the backend to be used by e.g.
defaults write NSGlobalDomain GSBackend libgnustep-cairo

=== Related Links ===
*[http://www.gnome.org/~mathieu/libart/libart.html LibArt]
*[http://www.cairographics.org/ Cairo]
*[http://www.gnustep.org/resources/documentation/Developer/Back/General/DefaultsSummary.html Docs about the backend-specific defaults settings]

[[Category:Bundles]]

GNUstep SVN Installation Guide

2009-02-03T17:36:52Z

Hns: /* Makefile Package */

This page is a step-by-step "How-to compile the latest svn version of GNUstep". It's mainly a short summary of different documents available.

<b>NOTE:</b> Instruction on installing GNUstep on Windows are available at [[Installation on Windows]].

== Prerequisites ==
Make sure to have the libraries mentioned as [[Dependencies]] installed – from their specific web sites or using your packaging system. (Note that some distributions/variants put header files into separate *-dev or *-devel packages. In this case these must be installed, too!) You may also want to have a look at the article [[Platform compatibility]] for notes on your platform.

==Download==
svn co http://svn.gna.org/svn/gnustep/modules/core
See also [[Using Subversion]].

== Makefile Package ==
You should install these packages as root.
<pre>
sudo
</pre>
Now, start with the Makefile Package.
<pre>
cd core/make
./configure
make
make install
</pre>
For configurations options see <code>./configure --help</code>. For example <code>./configure --with-layout=fhs</code> enables a more FHS-conformable filesystem layout. <code>./configure --prefix=MYPATH</code> will install into MYPATH instead of the standard /usr/GNUstep. Typical options are / (into root directly, as NeXT or Apple do), /usr/local/GNUstep, /opt/GNUstep.

Extra configuration needed every time you use "GNUstep" from a command-line:
<pre>
. /usr/GNUstep/System/Library/Makefiles/GNUstep.sh
</pre>
For Bourne compatible shells, or
<pre>
. /usr/GNUstep/System/Library/Makefiles/GNUstep.csh
</pre>
For csh or tcsh.

== Base/Foundation Library ==
<pre>
cd core/base
./configure
make
make install
</pre>

== GUI/AppKit Library ==
<pre>
cd core/gui
./configure
make
make install
</pre>

== Backend Library ==
The most stable GNUstep [[backend]] currently is the one dependent on libart, but is no longer actively developed. The libcairo has become the official backend but is still unstable.
<pre>
cd core/back
./configure --enable-graphics=cairo #for standard backend leave this line out
make
make install
</pre>

GNUstep SVN Installation Guide

2009-02-03T17:36:40Z

Hns: /* Makefile Package */

This page is a step-by-step "How-to compile the latest svn version of GNUstep". It's mainly a short summary of different documents available.

<b>NOTE:</b> Instruction on installing GNUstep on Windows are available at [[Installation on Windows]].

== Prerequisites ==
Make sure to have the libraries mentioned as [[Dependencies]] installed – from their specific web sites or using your packaging system. (Note that some distributions/variants put header files into separate *-dev or *-devel packages. In this case these must be installed, too!) You may also want to have a look at the article [[Platform compatibility]] for notes on your platform.

==Download==
svn co http://svn.gna.org/svn/gnustep/modules/core
See also [[Using Subversion]].

== Makefile Package ==
You should isntall these packages as root.
<pre>
sudo
</pre>
Now, start with the Makefile Package.
<pre>
cd core/make
./configure
make
make install
</pre>
For configurations options see <code>./configure --help</code>. For example <code>./configure --with-layout=fhs</code> enables a more FHS-conformable filesystem layout. <code>./configure --prefix=MYPATH</code> will install into MYPATH instead of the standard /usr/GNUstep. Typical options are / (into root directly, as NeXT or Apple do), /usr/local/GNUstep, /opt/GNUstep.

Extra configuration needed every time you use "GNUstep" from a command-line:
<pre>
. /usr/GNUstep/System/Library/Makefiles/GNUstep.sh
</pre>
For Bourne compatible shells, or
<pre>
. /usr/GNUstep/System/Library/Makefiles/GNUstep.csh
</pre>
For csh or tcsh.

== Base/Foundation Library ==
<pre>
cd core/base
./configure
make
make install
</pre>

== GUI/AppKit Library ==
<pre>
cd core/gui
./configure
make
make install
</pre>

== Backend Library ==
The most stable GNUstep [[backend]] currently is the one dependent on libart, but is no longer actively developed. The libcairo has become the official backend but is still unstable.
<pre>
cd core/back
./configure --enable-graphics=cairo #for standard backend leave this line out
make
make install
</pre>

GNUstep SVN installation guide.

2009-02-03T17:35:10Z

Hns: GNUstep SVN installation guide. moved to GNUstep SVN Installation Guide

#redirect [[GNUstep SVN Installation Guide]]

GNUstep SVN Installation Guide

2009-02-03T17:35:10Z

Hns: GNUstep SVN installation guide. moved to GNUstep SVN Installation Guide

This page is a step-by-step "How-to compile the latest svn version of GNUstep". It's mainly a short summary of different documents available.

<b>NOTE:</b> Instruction on installing GNUstep on Windows are available at [[Installation on Windows]].

== Prerequisites ==
Make sure to have the libraries mentioned as [[Dependencies]] installed – from their specific web sites or using your packaging system. (Note that some distributions/variants put header files into separate *-dev or *-devel packages. In this case these must be installed, too!) You may also want to have a look at the article [[Platform compatibility]] for notes on your platform.

==Download==
svn co http://svn.gna.org/svn/gnustep/modules/core
See also [[Using Subversion]].

== Makefile Package ==
<pre>
cd core/make
./configure
make
sudo make install

or if already using root:
make install
</pre>
For configurations options see <code>./configure --help</code>. For example <code>./configure --with-layout=fhs</code> enables a more FHS-conformable filesystem layout. <code>./configure --prefix=MYPATH</code> will install into MYPATH instead of the standard /usr/GNUstep. Typical options are / (into root directly, as NeXT or Apple do), /usr/local/GNUstep, /opt/GNUstep.

Extra configuration needed every time you use "GNUstep" from a command-line:
<pre>
. /usr/GNUstep/System/Library/Makefiles/GNUstep.sh
</pre>
For Bourne compatible shells, or
<pre>
. /usr/GNUstep/System/Library/Makefiles/GNUstep.csh
</pre>
For csh or tcsh.

== Base/Foundation Library ==
<pre>
cd core/base
./configure
make
make install
</pre>

== GUI/AppKit Library ==
<pre>
cd core/gui
./configure
make
make install
</pre>

== Backend Library ==
The most stable GNUstep [[backend]] currently is the one dependent on libart, but is no longer actively developed. The libcairo has become the official backend but is still unstable.
<pre>
cd core/back
./configure --enable-graphics=cairo #for standard backend leave this line out
make
make install
</pre>

Writing portable code

2009-01-30T12:12:27Z

Hns: /* When platform-specific code cannot be avoided */

GNUstep opens up some fairly interesting opportunities to target a number of platforms with the same source code, for example porting Mac OS X Cocoa applications to Linux, the BSDs, other Unices and (ultimately) Windows without significant re-engineering effort or degraded end-user functionality.

Some portability gotchas are listed below (please update when you run into a new one!):

== Porting Applications ==

=== Porting from NeXTSTEP (NX*) to GNUstep ===

For this you should have access to an old OPENSTEP installation, or find a friend who has one, otherwise you're simply better off just rewriting the application from scratch. There are some scripts which can be used to convert an application from NeXTSTEP to OPENSTEP located in <tt>/NextDeveloper/OpenStepConversion/ConversionScripts</tt>. They use a scripting language called "tops". I haven't been able, as yet, to locate a version of tops for Linux or any other operating system other than Mac OS X or OPENSTEP/Mach or NeXTSTEP. There are a few conversion applications which basically just use the tops scripts to do the conversion. They are actually two versions of the same program, but the second one doesn't run on NeXT, so here's both. These are:

* [ftp://next-ftp.peak.org/openstep/mach/apps/devtools/Conversion.0.5.NI.tar.gz]
* [ftp://next-ftp.peak.org/openstep/mach/apps/devtools/ConversionII.1.0.I.tar.gz]

You should be able to point it at the project directory you wish to convert and start the conversion. The GUI is very straightforward. You can also run the tops scripts on a Mac simply by saying:

tops -verbose -scriptfile {scriptfilename} {filestoconvert}

All of the files are converted in place. You must run all of the tops scripts in the ConversionScripts directory against the application code. It is considerably simply to use the existing applications. Unfortunately these scripts do not exist on Mac OS X, otherwise porting the Conversion application might be useful.

When you start the scripts, if you're running them on black hardware you should go get a cup of coffee and watch a movie with your wife or go code something else for a while. The conversion will take a good long while on an older machine. I haven't timed it on the Mac, though. Once this is done, there is still a long way to go. Read on.

OPENSTEP4.2/Mach had a class called NSCStringText. This class was primarily for apps which were converted from NeXTSTEP to use as a stop-gap measure in OpenStep. This is one of the main reasons why it isn't in GNUstep. You will need to make sure that any classes modified by the scripts to use NSCStringText will use NSText and it's related classes as appropriate. OPENSTEP4.2/Mac also had some other extensions on the OpenStep standard such as NXStreams. You will also need to convert any and all instances of NXStream to use NSData instead in order to make your app work with GNUstep.

If your app is fairly small, you shouldn't be in for a great shock, but if your app is heavily reliant on the old Text object from NeXTSTEP, you have a lot of work ahead. Other gaps which the scripts might leave are problems with NSUserDefaults which it can't fix on it's own.

=== Porting from Cocoa or OPENSTEP (NS*) to GNUstep ===

Porting from Cocoa or OPENSTEP to GNUstep has different aspects. First there is the compatibility of the basic Foundation Kit and Application Kit. We support a lot of classes, but not all of them and the same is true for specific methods, specifically newly introduced classes and methods in Cocoa may still be missing as GNUstep started out aiming at OpenStep compatibility.

Second you have all the additional frameworks and libraries programmers on Mac OS X take for granted, for some of them free replacements exists, for most they are still missing. Mac OS X developers should try and avoid CoreFoundation as this will complicate your dependency situation on non-Mac hosts, even if that part of CoreFoundation has actually been ported. GNUstep Base and the FoundationKit offer many parts of the CoreFoundation functionality in a natural [[Objective-C]] manner. To be a bit more specific:

* don't use Core* (CoreFoundation, CoreSound, CoreAnimation, ...)
* don't use KeyChain
* don't use Carbon
* don't use Quartz
* don't use QuickTime
* don't use WebKit (GCC 4.1 and up support ObjC++, but currently, there exists no WebKit port for GNUstep)
* don't use altivec features or the vecLib.framework (a collection of functions for vector manipulation, an Apple specific extension)
* don't use anything else we do not provide

If you committed none of these portability evils, the rest is relatively straightforward:

# [[Writing Makefiles|Write a new GNUstep make file]] for the project (very easy, still there is currently no automatic way to do so).
# Make sure the Nib files are readable by GNUstep.
## When saving a NIB file in project builder, ensure that "10.2 or later" format is selected. Also, ensure that "Use text archive format" is NOT checked, as this created problems.
## Another option is to load them into Gorm and convert them into .gorm files. If they're from OPENSTEP or Mac OS X 10.1 or earlier, see [[#Porting_.nib_files_from_OPENSTEP_or_Mac_OS_X_10.1_and_earlier|below]].
# Provide an Info.plist.

=== Porting from GNUstep to Cocoa ===

This should be an easy transition since GNUstep implements most of Cocoa, except for the very Apple specific classes such as the scripting extensions. Since Gorm does not yet save .nib files, you will need to create the interfaces using IB. Also there is a gorm reading/parsing framework for Cocoa in the works as well, so please stay tuned.

Will need to:

* Make a Project Builder project for your app or
* an Xcode project for your app

Do the following:

* Open Xcode
* Choose Application (if your project is an application)
* Enter the name and location you wish the Project to reside at
* Copy your files from your GNUstep application into the new project
* Using the "Add Existing Files" option to add these files to your project

You should preserve your original directory structure if you want to distribute one package for both GNUstep and Cocoa.

== Stumbling Blocks ==

=== Apple's Cocoa.h ===

It is there to enable pre-compiled headers and speed up compile time thusly. Anyway, it contains just two lines:

#import <Foundation/Foundation.h>
#import <AppKit/AppKit.h>

On older GNUstep systems, you may have to work around this by providing your own or replace your include of <Cocoa/Cocoa.h> with just the above, which will also work on OS-X.

=== Distinguishing Between Cocoa and GNUstep ===

#ifdef GNUSTEP
''/* GNUstep code goes here ... */''
#else
''/* OS-X Cocoa native code goes here ... */''
#endif

=== Porting .nib files from OPENSTEP or Mac OS X 10.1 and earlier ===

GNUstep can handle nibs from 10.2 or later of Mac OS X, but it can't read nibs made with NeXTSTEP, OpenStep or Mac OS 10.1 or earlier. On the latest version of Mac OS X, this is a simple matter of loading the .nibs into Interface Builder.app and saving them in the 10.2 format. Another possibility is using nib2gmodel, the only one when porting from OPENSTEP, and, mind you, you need to do the converting ''there''. First, get [http://freshmeat.net/projects/nib2gmodel/ nib2gmodel], follow the included instructions to build and install it. Once that's done you're ready to begin:

Run the nib2gmodel program on your nib:

nib2gmodel mygui.nib mygui.gmodel

This should create the .gmodel as a plist. I recommend that you convert the gmodel to a "normal" plist instead of an XML plist. You can do that by doing this on OS X:

pl < mygui.gmodel -output mygui.ser
pl > mygui.gmodel -input mygui.ser
rm mygui.ser

Now you can either use the gmodel as it is, or you can convert it to a .gorm file.

==== Gmodel to .gorm conversion ====

NOTE: Conversion from gmodel to .gorm is experimental and will probably remain so for a while. It currently works in the majority of cases, but there are still improvements which need to be made.

Conversion to a .gorm file is relatively straightforward:

* Start Gorm.app.
* Choose Gorm->Document->Open and find the gmodel you wish to load.
* Gorm will prompt you to either define the superclass for classes it doesn't know about or to parse the headers.

After you've defined all of the unknown classes, Gorm should complete the conversion. Once this is done you should save the result to make sure you don't loose your work.

==== .nib to .gorm conversion ====

Since it's possible to load nibs into GNUstep application now, it should be easy to convert 10.2 or later nibs by simply loading them into Gorm and saving them as .gorm files. This is not strictly necessary since GNUstep can handle them natively.

NOTE: Our recommendation for this is not to use the nib2gmodel conversion and simply to use the nibs directly, if you can or to convert them as described above by loading them into Interface Builder and saving them as the newer nib format.

=== Xcode conversion ===

* how to convert Xcode project to GNUstep project (creating a GNUstep [http://www.gnustep.it/nicola/Tutorials/WritingMakefiles/index.html Makefile] or [[ProjectCenter]])

* [[pbxbuild]] - this program converts an Xcode project into a set of targets and directories in which you can build by simply using make.

* PBTOMAKE. [http://www.macdevcenter.com/pub/a/mac/2004/04/20/xcodetounix.html xcodetounix] (download at [http://members.bellatlantic.net/%7Evze35xda/software.html]) is a tool for converting Xcode and Project Builder files to generic Unix Makefiles. It would probably be a good start for converting to a GNUstep makefile.

== Notes ==

=== Do not rely on tools available in development environment ===

All the world is not Linux or FreeBSD or Windows. System constants may be different on different platforms. Paths to command-line tools, the parameters they accept and locations of temporary directories may be different to what you are used to on your platform.

* [[Foundation|GNUstep Base]] and the [[Foundation|FoundationKit]] offer some of this functionality "for free".
* Try not to hard code paths and so on into your code, use macros (not recommended), or even better an abstraction mechanism.
* Avoid hard-coding system constants, or platform-specific ones where POSIX or commonly-accepted ones exist (and we're not talking about glibc here :-)
* Try to avoid advanced features of the linker, such as weak symbols, which may not be present on non-ELF systems. While this will work perfectly on most systems, it is not portable to all systems, most notably Windows.

=== When platform-specific code cannot be avoided ===

There are cases where you may need to write platform-specific code, especially in the case of desktop applications and services which make use of facilities not standardised by POSIX or by the FoundationKit and AppKit specifications, at least use [[Identifying the target platform|standard platform macros]].

These platform-specific, or even desktop-specific requirements could be re-used by other projects - and even enhance desktop-integration efforts for GNUstep applications - by abstracting out common code into currently hypothetical [[PlatformKit]] and [[DesktopServicesKit]] frameworks.

[[Category:Project procedures]]

=== Cross Compiling ===

See [[Cross_Compiling]]

Cross Compiling

2009-01-30T12:11:38Z

Hns:

Cross Compiling and GNUstep depends on what you want to achieve.

The following is based on [http://groups.google.com/group/gnu.gnustep.discuss/browse_frm/thread/06920400aed740d2 this discussion] on the mailing list.

See also: [[Writing_portable_code]]

== I have a GNUstep source running on Linux/GNUstep and want the same application to run on OSX ==

You have several options - more or less complex.

=== Copy source files to OSX and use gnustep-make ===

The simplest, and best option is obviously to install [[Media:FOSDEM2007Make-2.0.pdf|gnustep-make]] on your Mac.

curl ftp://ftp.gnustep.org/pub/gnustep/core/gnustep-make-2.0.5.tar.gz
./configure
make
sudo make install

and then compile your project by typing 'make'. You get a native Apple OSX application compiled against the Apple OSX ObjC frameworks ... using
the same GNUmakefiles you were using on GNU/Linux/*BSD/Windows. :-)
--N. Pero

Additionally to the already suggested use of Xcode, you can build GNUstep on OS X with the apple-apple-apple combo.
While this might need a tweak or two to work, this gives you a thin layer of GNUstep (its additions) onto what Cocoa already provides.
--Markus Hitter

=== Copy source files to OSX to develop, build and debug using Xcode ===

Add a wrapping Xcode project (in addition to the GNUstep makefile) and configure it to compile directly on OSX for OSX using the OSX Cocoa frameworks.
You can share the sources e.g. through SVN.
There is no problem having GNUmakefiles and some .xcodeproj in the same source code directory.
The main benefit of this approach is that you can use the Xcode/gdb integration for debugging.

Examples using this approach:
1. SWK Browser from the GNUstep SWK project, DataBuilder from
2. GSCoreData (look into the sources at www.gna.org)

Development is done by either working on Linux and using GORM/Project Center and compiling for Linux, or on OSX opening the project in Xcode.
The only thing to keep in mind is that you must also update the Xcode project or the GNUmakefile if you add source files or resources.
The GNUstep .app bundle is different and runs on Linux only.
The OSX .app bundle runs only on OSX, i.e. there is no single bundle that covers all architectures (unless you do some additional tricks).

=== Install GNUstep on OSX using MacPorts ===

Then, you can set up an identical build environment on both machines.
The drawback is that you don't have a "native" OSX application which you can easily launch by a double-click on the .app icon.

Benoit Astruc writes: I think I have done this :
- I installed GNUstep Make and BaseAdditions on Mac OS X 10.3 (it was 2 years ago so not the Make 2.0 version, I don't know if it works with
the new version),
- I used a GNUmakefile like this one :
# This usually happens when you source GNUstep.sh, then run ./configure,
# then log out, then log in again and try to compile
ifeq ($(GNUSTEP_MAKEFILES),)
$(error You need to run the GNUstep configuration script before compiling!)
endif
include $(GNUSTEP_MAKEFILES)/common.make
APP_NAME = WRP
WRP_MAIN_MODEL_FILE = MainMenu
WRP_APPLICATION_ICON = WRP.icns
WRP_PRINCIPAL_CLASS = NSApplication
WRP_RESOURCE_FILES = gui/* Images/* Resources/*
WRP_OBJC_FILES = main.m \
...
snip a bunch of sources files
...
DEGeneralPrefsController.m \
GSStringCat.m
include GNUmakefile.preamble
include $(GNUSTEP_MAKEFILES)/application.make

There was a trick however, the first time I had to write manually some file, WRPInfo.plist if I remember well, and then it was used.
I don't do anything on this app since 2 years ago so I don't remember well, but I am pretty sure I had nothing more to do.
And the result was a perfectly Mac OS X app build with GNUstep make.

=== Real cross-compiling (building on Linux for MacOS X) ===

This means that you have a gcc version on your Linux machine that emits executables that run on OSX. Unfortunately, OSX uses MACH-O binaries and building a cross-compiling gcc is very tricky.
So I would not consider this as a reasonable option.

== I have an Xcode project and want to run on Linux ==

a) your target machine has a compiler
Here, you have to check that you are not using too specific
frameworks. Then, add a GNUmakefile. Copy the files to your Linux
system and run the GNUstep makefile.

b) your target machine is an embedded system
In this case, you need a cross-compiler on the build host. This can be
a full Linux machine or a OSX machine (but it is more difficult to get
a working cross-compiler running on OSX).

== I have an Xcode project and want to run on Windows ==

Please refer to [http://www.gnustep.org/experience/Windows.html]