Commit ebe81e27 authored by Adi Dascal's avatar Adi Dascal

Initial revision

parents
The Gnopernicus Team
=====================
Adriana Iobb <ai@baum.de>
Draghi Puterity <mp@baum.de>
Sprencz Pal Csongor <ps@baum.ro>
Szijjarto Iuliu <is@baum.ro>
Remus Draica <rd@baum.ro>
Adi Dascal <ad@baum.ro>
This diff is collapsed.
2001-12-03 Adi Dascal <ad@baum.ro>
* gnopernicus/Makefile.am:
Add srconf to SUBDIRS
* gnopernicus/srconf:
Create Makefile.am
Basic Installation
==================
These are generic installation instructions.
The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation. It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, a file
`config.cache' that saves the results of its tests to speed up
reconfiguring, and a file `config.log' containing compiler output
(useful mainly for debugging `configure').
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release. If at some point `config.cache'
contains results you don't want to keep, you may remove or edit it.
The file `configure.in' is used to create `configure' by a program
called `autoconf'. You only need `configure.in' if you want to change
it or regenerate `configure' using a newer version of `autoconf'.
The simplest way to compile this package is:
1. `cd' to the directory containing the package's source code and type
`./configure' to configure the package for your system. If you're
using `csh' on an old version of System V, you might need to type
`sh ./configure' instead to prevent `csh' from trying to execute
`configure' itself.
Running `configure' takes awhile. While running, it prints some
messages telling which features it is checking for.
2. Type `make' to compile the package.
3. Optionally, type `make check' to run any self-tests that come with
the package.
4. Type `make install' to install the programs and any data files and
documentation.
5. You can remove the program binaries and object files from the
source code directory by typing `make clean'. To also remove the
files that `configure' created (so you can compile the package for
a different kind of computer), type `make distclean'. There is
also a `make maintainer-clean' target, but that is intended mainly
for the package's developers. If you use it, you may have to get
all sorts of other programs in order to regenerate files that came
with the distribution.
Compilers and Options
=====================
Some systems require unusual options for compilation or linking that
the `configure' script does not know about. You can give `configure'
initial values for variables by setting them in the environment. Using
a Bourne-compatible shell, you can do that on the command line like
this:
CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
Or on systems that have the `env' program, you can do it like this:
env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
Compiling For Multiple Architectures
====================================
You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory. To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'. `cd' to the
directory where you want the object files and executables to go and run
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
If you have to use a `make' that does not supports the `VPATH'
variable, you have to compile the package for one architecture at a time
in the source code directory. After you have installed the package for
one architecture, use `make distclean' before reconfiguring for another
architecture.
Installation Names
==================
By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc. You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH'.
You can specify separate installation prefixes for
architecture-specific files and architecture-independent files. If you
give `configure' the option `--exec-prefix=PATH', the package will use
PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.
In addition, if you use an unusual directory layout you can give
options like `--bindir=PATH' to specify different values for particular
kinds of files. Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.
If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
Optional Features
=================
Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System). The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.
For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.
Specifying the System Type
==========================
There may be some features `configure' can not figure out
automatically, but needs to determine by the type of host the package
will run on. Usually `configure' can figure that out, but if it prints
a message saying it can not guess the host type, give it the
`--host=TYPE' option. TYPE can either be a short name for the system
type, such as `sun4', or a canonical name with three fields:
CPU-COMPANY-SYSTEM
See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
need to know the host type.
If you are building compiler tools for cross-compiling, you can also
use the `--target=TYPE' option to select the type of system they will
produce code for and the `--build=TYPE' option to select the type of
system on which you are compiling the package.
Sharing Defaults
================
If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists. Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
Operation Controls
==================
`configure' recognizes the following options to control how it
operates.
`--cache-file=FILE'
Use and save the results of the tests in FILE instead of
`./config.cache'. Set FILE to `/dev/null' to disable caching, for
debugging `configure'.
`--help'
Print a summary of the options to `configure', and exit.
`--quiet'
`--silent'
`-q'
Do not print messages saying which checks are being made. To
suppress all normal output, redirect it to `/dev/null' (any error
messages will still be shown).
`--srcdir=DIR'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
`--version'
Print the version of Autoconf used to generate the `configure'
script, and exit.
`configure' also accepts some other, not widely useful, options.
SUBDIRS= braille srlow srcore gnopi srconf docs
pkgconfigdir = $(libdir)/pkgconfig
pkgconfig_DATA = gnopernicus-1.0.pc
EXTRA_DIST= \
xml-i18n-extract.in \
xml-i18n-merge.in \
xml-i18n-update.in \
gnopernicus-1.0.pc.in \
autogen.sh \
./magnifier \
./speech \
./kbd_mouse
README
This is the Very Early Release of the BAUM Gnopernicus Project
***********************************************************************************
* *
* Welcome to the BAUM Gnopernicus Project! *
* *
***********************************************************************************
If you have not already done so, please visit
http://developer.gnome.org/projects/gap
http://www.baum.de
http://www.baum.ro
Contents of this package
========================
The directories within this package are arranged as follows:
gnopi : this directory contains the userinterface programs which call 'gnopi'.
This program will configure all settings of gnopernicus. The gnopi.c
contains the main menu of Gnopernicus.
braille : libbrl is a SO ( shared object ) which accepts input in BML ( Braille
Markup Language, a XML dialect developed @ Baum) and drives many
known Braille devices ( currently just a couple of Baum devices are
supported ).BML supports multiple language translation tables, mixing
of text and dots, different Braille and cursor styles etc. libbrl
also produce an input stream from the Braille device tothe client.See
brl_*_test.xml for BML examples.
Note : The user needs rw access to the serial port in order to use it.
srlow : There are two subdirectories in srlow : libsrlow and test.
libsrlow : contains code that monitors events in system. From this
events collects necessary informations and notifies registered
clients .
test : this directory contains examples of how libsrlow could be used
in application.
srcore : srcore - is a console application (for the moment...)which implements
the Screen Reader / Magnifier logic. It gets the input from at-spi
through srlow, keyboard, braille and speech devices and produces
output for Braille, Speech and Magnifier. The output is produced as
XML streams. This is a very very very early release. Basicaly, just
a proof of concept.
srconf : a simple test program that uses gconf.
kbd_mouse : no code available, yet.
speech : no code available, yet.
magnifier : no code available, yet.
docs : this directory contains documentation for the SRLow. Documentation is
currently limited to API documentation for the C bindings API, and is
built from sourcesvia the 'gtk-doc' system.
Dependencies
============
In order to get gnopernicus installed on your system, you need to have the following
packages installed as well:
at-spi-1.0
gconf-2.0
gtk+-2.0
gtk-doc (optional-necessary just for docs generation)
libgnome-2.0
libxml-2.0
Building
========
To compile gnopernicus on your system, you will need to take several steps to setup
the tree for compilation. You can do all these steps at once by running:
$ ./autogen.sh
Basically this does the following for you:
$ aclocal; automake; autoconf
The above commands create the "configure" script. Now you can run the configure
script to create all the Makefiles.
Before running autogen.sh or configure, make sure you have GNUTools in your path.
(GNUTools = automake, autoconf,libtool etc. For more information visit www.gnu.org)
Note that autogen.sh runs configure for you. If you wish to pass options like
--prefix=/opt/gnome-2.0 to configure you can give those options to autogen.sh and
they will be passed on to configure.
Read more about building/installation in the INSTALL file.
_Gnopernicus Team.
In the near future:
********************
* Fix all the GUI applications using libglade
Libglade is a library that performs a similar job to the C source
output routines in the GLADE user interface builder. Whereas GLADE's
output routines create C code that can then be compiled, libglade
builds the interface from an XML file ( GLADE's save format ) at
runtime. This way you can change the look of a program without
needing to recompile.
* More of everything according to AT-SPI evolution(the main dependency)
of gnopernicus
Things to think about:
**********************
* Optimizing srlow ( Screen Reader Low )
\ No newline at end of file
#undef ENABLE_NLS
#undef HAVE_GETTEXT
#undef HAVE_CATGETS
#undef HAVE_DLADDR
#undef HAVE_GET_TEXT
#undef HAVE_LC_MESSAGES
#undef HAVE_STPCPY
#!/bin/sh
# Run this to generate all the initial makefiles, etc.
srcdir=`dirname $0`
test -z "$srcdir" && srcdir=.
PKG_NAME="gnopernicus"
USE_GNOME2_MACROS=1 . gnome-autogen.sh
SUBDIRS= libbrl test
This diff is collapsed.
NULL=
lib_LTLIBRARIES = libbrl.la
INCLUDES = -I$(top_builddir) \
$(LIBBRL_CFLAGS)
CFLAGS += $(LIBBRL_CFLAGS)
LDFLAGS = $(LIBBRL_LIBS) @LT_VERSION_INFO@
LDADD = $(LIBBRL_LIBS)
libbrlincludedir =$(includedir)/gnopernicus-1.0/libbrl
loaderdir=$(libdir)/gnopepernicus-1.0
libbrlinclude_HEADERS = baumbrl.h \
braille.h \
brlxmlapi.h \
brlxml.h \
sercomm.h
libbrl_la_SOURCES = baumbrl.h \
braille.h \
brlxmlapi.h \
brlxml.h \
sercomm.h \
sercomm.c \
baumbrl.c \
braille.c \
brlxml.c
EXTRA_DIST =./brlTables
This diff is collapsed.
This diff is collapsed.
/***************************************************************************
baumbrl.h - description
-------------------
begin : Wed Sep 26 2001
copyright : (C) 2001 by Draghi Puterity
email : mp@baum.de
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef _BAUMBRL_H
#define _BAUMBRL_H
#include "braille.h"
int baum_brl_open_device (char* DeviceName, short Port, BRL_DEV_CALLBACK DeviceCallback, BRL_DEVICE *Device);
#endif
/***************************************************************************
braille.c - description
-------------------
begin : Wed Sep 26 2001
copyright : (C) 2001 by Draghi Puterity
email : mp@baum.de
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "braille.h"
#include "baumbrl.h"
// Globals
static BRL_DEVICE* CurrentDevice = NULL;
static unsigned char* Dots = NULL;
// static short CursorShape = 0x0C; // dot 7/8
// static short CursorMask = 0x0C; // dot 7/8
// static short BrailleStyle = 8; // 8 dot Braille
// static short AttrStyle = 0; // ...
// static short CursorPos = -1; // ... no cursor
// static char* Text = NULL;
// static unsigned long* Attrs = NULL;
// static unsigned char *TranslationTable = NULL; // !!! consider MBCS !!!
static BRAILLE_EVENT_PROC ClientEventProc = NULL;
// Deviceless Functions
void brl_init()
{
brl_terminate();
// !!! TBI !!! init globals here
}
void brl_terminate()
{
brl_close_device();
// if (TranslationTable)
// {
// free (TranslationTable);
// TranslationTable = NULL;
// }
}
/*
int brl_load_translation_table (char* FileName)
{
int rv = 0;
FILE *fp;
if (TranslationTable) free (TranslationTable);
// !!! TBR !!! consider MBCS
TranslationTable = calloc (256, sizeof(unsigned char));
// assert (TranslationTable);
fp = fopen (FileName, "rb");
if (fp)
{
fread (TranslationTable, 1, 256, fp);
rv = 1;
}
else
{
fprintf (stderr, "brl_load_translation_table: could't open the file %s\n", FileName);
// errno =
}
return rv;
}
int brl_text_to_braille (char *Text, unsigned char *Dots, short MaxLen)
{
if (!TranslationTable)
{
// errno =
fprintf (stderr, "brl_text_to_braille: translation table not initialized\n");
return 0;
}
return 1;
}
*/
// Device Related Functions
// Device Callback
void DeviceCallback (BRAILLE_EVENT_CODE Code, BRAILLE_EVENT_DATA *Data)
{
// call the client callback
// NOTE: could add some preprocessing here
if (ClientEventProc) ClientEventProc (Code, Data);
}
// API Functions
int brl_open_device (char *DeviceName, int Port, BRAILLE_EVENT_PROC EventProc)
{
int rv = 1;
// store the client callback
ClientEventProc = EventProc;
// create an empty BRL_DEVICE structure
CurrentDevice = calloc (sizeof(BRL_DEVICE), sizeof(unsigned char));
if (CurrentDevice)
{
// !!! TBR !!! rewrite this for a plugin architecture
// load_library
// open_device
// if (stricmp("VARIO", DeviceName) == 0)
if ( strcmp("VARIO", DeviceName) == 0 ||
strcmp("VARIO20", DeviceName) == 0 ||
strcmp("VARIO80", DeviceName) == 0 ||
strcmp("DM80P", DeviceName) == 0 ||
strcmp("INKA", DeviceName) == 0
)
{
rv = baum_brl_open_device (DeviceName, Port, DeviceCallback, CurrentDevice);
}
// else if (stricmp("POWERBRAILLE", DeviceName) == 0)
else if (strcmp("PB40", DeviceName) == 0)
{
// rv = tsc_open_device (DeviceName, CurrentDevice, deviceCallback);
}
// else if
else
{
// unknown device
fprintf (stderr, "bra_open_device: unknown device\n");
rv = 0;
// errno =
}
if (rv)
{
// allocate the the rest of the resources here
// Text = calloc (CurrentDevice->CellCount, sizeof (char));
// memset (Text, ' ', CurrentDevice->CellCount * sizeof (char));
// Attrs = calloc (CurrentDevice->CellCount, sizeof (unsigned long));
Dots = calloc (CurrentDevice->CellCount, sizeof (unsigned char));
// assert (Text && Attrs && Dots);
// clear all cells
CurrentDevice->send_dots(Dots, CurrentDevice->CellCount, 1); // blocking send ;-)
}
else
{
fprintf (stderr, "brl_open_device: open device failed\n"); // !!! TBR !!! be more explicit here
brl_close_device();
}
}
return rv;
}
int brl_get_device (BRL_DEVICE *Device)
{
if (CurrentDevice)
{
memcpy (Device, CurrentDevice, sizeof (BRL_DEVICE));
return 1;
}
else
{
fprintf (stderr, "brl_get_device: no device opened"); // !!! TBR !!! be more explicit here
return 0;
}
}
void brl_close_device ()
{
if (CurrentDevice)
{
if(CurrentDevice->close_device) CurrentDevice->close_device();
free (CurrentDevice);
CurrentDevice = NULL;
}
ClientEventProc = NULL;
}
short brl_get_disp_id (char* Role, short No)
{
int i;
short rv = -1;
short type_no = -1;
if (CurrentDevice)
{
if (Role)
{
// we have a role, search for that role + displayNo
for (i = 0; i < CurrentDevice->DisplayCount ; ++i)
{
if ( (strcasecmp (Role, "main") == 0 ) && (CurrentDevice->Displays[i].Type == bdt_main))
{
++type_no;
if (type_no == No)
{
rv = i;
break;
}
}
else if ((strcasecmp (Role, "status") == 0 ) && (CurrentDevice->Displays[i].Type == bdt_status))
{
++type_no;
if (type_no == No)
{
rv = i;
break;
}
}
else if ((strcasecmp (Role, "auxh") == 0 ) && (CurrentDevice->Displays[i].Type == bdt_aux_horizontal))
{
++type_no;
if (type_no == No)
{
rv = i;
break;
}
}
else if ((strcasecmp (Role, "auxv") == 0 ) && (CurrentDevice->Displays[i].Type == bdt_aux_vertical))
{
++type_no;
if (type_no == No)
{
rv = i;
break;
}
}
} // end for
}
else
{
// no role, the No is the ID if validated
if (No < CurrentDevice->DisplayCount)
{
rv = No;
}
}
}
return rv;
}
void brl_clear_all()
{
if ( CurrentDevice &&
Dots )
{
memset (&Dots[0], 0, CurrentDevice->CellCount);
}
}
void brl_clear_display (short Display)
{
BRL_DISPLAY *brd;
// set to 0 all the cells coresponding to the display
if ( Display < (CurrentDevice->DisplayCount) &&
Display >= 0 &&
CurrentDevice &&
Dots)
{
brd = &(CurrentDevice->Displays[Display]);
memset (&Dots[brd->StartCell], 0, brd->Width);
}