apjanke / octave-slf4o Goto Github PK

View Code? Open in Web Editor NEW

5.0 3.0 0.0 4.31 MB

A simple logging framework for GNU Octave

License: GNU General Public License v3.0

Makefile 23.93% MATLAB 76.07%

octave-slf4o's People

Contributors

Stargazers

Watchers

octave-slf4o's Issues

Get documentation into Octave/QHelp format

Convert the documentation in doc/ to texinfo
Convert the helptext for all funtions and methods to texinfo
Documentation-building scripts to turn those in to QHelp files, and add the PKG_ADD hack to load the QHelp manual
Convert the Makefile to Octave package style
Fix bugs!

The documentation-building scripts and Makefile can be taken from the Tablicious package.

Follows up #3.

Octave crashes when trying to launch the configurator GUI

When I try to launch the configurator GUI, Octave throws some Java errors and crashes. This happens on both Octave.app 4.4.1 and vanilla Homebrewed Octave 5.2.0 on my macOS 10.14.6 system.

When this happens, the prompt for the legacy Java 6 installer pops up.

Here's what it looks like when run from command line Octave 5.2.0:

octave:5> logger.initSLF4O
warning: function ./+logger/error.m shadows a built-in function
OpenJDK 64-Bit Server VM warning: Archived non-system classes are disabled because the java.system.class.loader property is specified (value = "org.octave.OctClassLoader"). To use archived non-system classes, this property must not be set
octave:6> logger.Log4jConfigurator.showGui
warning: function ./+logger/error.m shadows a built-in function
No Java runtime present, requesting install.
$

(That $ is me being dropped back to the shell after Octave crashed.)

How do I reference Java constants?

I need to do this from M-code:

                rootLogger.setLevel(org.apache.log4j.Level.INFO);

where org.apache.log4j.Level.INFO is referencing the public static final field INFO defined on the Java class org.apache.log4j.Level. How do I do that?

isa() does not work to check Java interface implementation

Unlike Matlab's isa(), Octave's isa() does not answer true if you do isa(someJavaObject, 'some.interface.it.Implements'). This means we can't use mustBeA() in some of our stuff.

Report this upstream to Octave.

Possibly implement our own workaround using Java instanceof checks/reflection.

Have Makefile build dist from current workspace state instead of HEAD commit

I think you should be able to build and test your distribution against the pending changes in your working copy before committing those changes. That means that the make dist target should use the current file state, instead of doing a git archive export from the last commit. (Maybe that git archive version could be kept around as a make realdist or make commitdist target.)

Unify error identifiers

The error() calls variously use the "dispstrlib:", "slf4o:", or "logger:" prefix in the error identifiers. Pick one and use it throughout.

Warning about Mcode-examples upon load

>> pkg load slf4o
warning: load_path: /Users/janke/Library/Application Support/Octave.app/4.4.1/pkg/slf4o-0.1.0-SNAPSHOT/lib/matlab/dispstr/dispstr-1.1.1/Mcode-examples: No such file or directory
warning: load_path: /Users/janke/Library/Application Support/Octave.app/4.4.1/pkg/slf4o-0.1.0-SNAPSHOT/lib/matlab/dispstr/dispstr-1.1.1/Mcode-examples: No such file or directory
warning: called from
    installed_packages at line 42 column 19
    load_packages at line 27 column 22
    pkg at line 457 column 7
error: package slf4o is not installed
error: called from
    load_packages at line 41 column 7
    pkg at line 457 column 7
>>

Hmmmmm...

We're disabling the shadowed-function warning

We define a package-scoped function error() inside the +logger package. Octave mistakenly thinks that this shadows the built-in error() function, and repeatedly issues warnings like this:

warning: function [...]/SLF4O/inst/+logger/error.m shadows a built-in function

So we're just doing warning off Octave:shadowed-function in PKG_ADD. That's a gross hack. See if that can be fixed.

logger.version is broken

logger.version is broken because it relies on the VERSION file, which is outside the inst/ directory and thus not installed as part of the package.

Change its implementation to parse the DESCRIPTION file instead. (That gets installed as part of the package, right?) It should detect DESCRIPTION in its location in both source repo and installed-package cases.

pkg installation not working in Octave.app

I tried installing it under Octave.app, and all I got was this.

>> pkg load slf4o
warning: load_path: /Users/janke/Library/Application Support/Octave.app/4.4.1/pkg/slf4o-0.1.0-SNAPSHOT/lib/matlab/dispstr/dispstr-1.1.1/Mcode-examples: No such file or directory
warning: load_path: /Users/janke/Library/Application Support/Octave.app/4.4.1/pkg/slf4o-0.1.0-SNAPSHOT/lib/matlab/dispstr/dispstr-1.1.1/Mcode-examples: No such file or directory
warning: called from
    installed_packages at line 42 column 19
    load_packages at line 27 column 22
    pkg at line 457 column 7
error: package slf4o is not installed
error: called from
    load_packages at line 41 column 7
    pkg at line 457 column 7
>> logger.initSLF4O
warning: load_path: /Users/janke/Library/Application Support/Octave.app/4.4.1/pkg/slf4o-0.1.0-SNAPSHOT/lib/matlab/dispstr/dispstr-1.1.1/Mcode-examples: No such file or directory
warning: load_path: /Users/janke/Library/Application Support/Octave.app/4.4.1/pkg/slf4o-0.1.0-SNAPSHOT/lib/matlab/dispstr/dispstr-1.1.1/Mcode-examples: No such file or directory
error: 'logger' undefined near line 1 column 1
>> logger.info('hello world!')
warning: load_path: /Users/janke/Library/Application Support/Octave.app/4.4.1/pkg/slf4o-0.1.0-SNAPSHOT/lib/matlab/dispstr/dispstr-1.1.1/Mcode-examples: No such file or directory
warning: load_path: /Users/janke/Library/Application Support/Octave.app/4.4.1/pkg/slf4o-0.1.0-SNAPSHOT/lib/matlab/dispstr/dispstr-1.1.1/Mcode-examples: No such file or directory
error: 'logger' undefined near line 1 column 1
>> path
warning: load_path: /Users/janke/Library/Application Support/Octave.app/4.4.1/pkg/slf4o-0.1.0-SNAPSHOT/lib/matlab/dispstr/dispstr-1.1.1/Mcode-examples: No such file or directory

Octave's search path contains the following directories:

.
/Users/janke/Library/Application Support/Octave.app/4.4.1/pkg/slf4o-0.1.0-SNAPSHOT/lib/matlab/dispstr/dispstr-1.1.1/Mcode-examples
/Users/janke/Documents/octave
/Applications/Octave-4.4.1.app/Contents/Resources/usr/Cellar/[email protected]/4.4.1/share/octave/site/m
/Applications/Octave-4.4.1.app/Contents/Resources/usr/Cellar/[email protected]/4.4.1/share/octave/site/m/startup

Add "Introduction" section to manual

The user manual (in doc/slf4o.texi.in) could use an "Introduction" section. Add one.

Finish conversion to Octave `pkg` package format

Finish converting this to Octave pkg package format:

Add INDEX file
Add DESCRIPTION files
Add COPYING file
Convert the documentation to texinfo
Documentation-building scripts to turn those in to QHelp files, and add the PKG_ADD hack to load the QHelp manual
Convert the Makefile to Octave package style
Probably re-license under GPL

This can be done based on the Tablicious package.

"class not found" warning upon pkg installation

>> pkg install https://github.com/apjanke/octave-slf4o/archive/master.zip
warning: function /Users/janke/Library/Application Support/Octave.app/4.4.1/pkg/slf4o-0.1.0-SNAPSHOT/+logger/error.m shadows a built-infunction
warning: function /Users/janke/Library/Application Support/Octave.app/4.4.1/pkg/slf4o-0.1.0-SNAPSHOT/+logger/error.m shadows a built-infunction
class not found: dispstrlib.Displayable
error: called from
    doc_cache_create>create_cache at line 109 column 18
    gen_doc_cache_in_dir>@<anonymous> at line 143 column 16
    doc_cache_create>gen_doc_cache_in_dir at line 144 column 9
    doc_cache_create at line 55 column 12
    install>generate_lookfor_cache at line 793 column 5
    install at line 223 column 7
    pkg at line 437 column 9
>>

This looks ignorable. Looks like it's because the library is not initialized at package installation time.

The sub-library loading might be too fancy for Octave. Maybe I should just merge the Dispstr stuff into the main inst/ directory and forget about the lib/matlab/dispstr/ approach.

"## -- texinfo --" is ignored if it is the first line in file

Because of this logic for slurping up leading blank lines and copyright blocks:

    my $fh = IO::File->new($mfile, "r")
        or die "Error: Could not open file $mfile: $!\n";

    # Skip leading blank lines
    while (<$fh>) {
        last if /\S/;
    }
    # First block may be copyright statement; skip it
    if (m/\s*[%\#][\s\#%]* Copyright/) {
        print "Skipping Copyright block\n";
        while (<$fh>) {
            last unless /^\s*[%\#]/;
        }
    }

   [...]

   while (<$fh>) {
        my $line_num = $fh->input_line_number();
        [...]
   }

See how that attempt to skip leading blank lines will actually slurp in the "## -- texinfo --" line if it's the first line in the file, and it'll then be discarded?

Remove the bogus dispstrlib loading code from initSLF4O

It's vestigial from when dispstrlib was shipped in lib/.

Convert code to GNU Octave code style

Right now my source code is mostly in Matlab style. Consider converting it to GNU Octave style, as a courtesy to Octave users who are probably more used to that.

apjanke / octave-slf4o Goto Github PK

octave-slf4o's People

Contributors

Stargazers

Watchers

octave-slf4o's Issues

Recommend Projects

Recommend Topics

Recommend Org