diff --git a/AUTHORS b/AUTHORS new file mode 100644 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,1 @@ +fr33domlover diff --git a/COPYING b/COPYING new file mode 100644 --- /dev/null +++ b/COPYING @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/ChangeLog b/ChangeLog new file mode 100644 --- /dev/null +++ b/ChangeLog @@ -0,0 +1,17 @@ +The changes are recorded by the version control system, Darcs. To see a log +quickly from the terminal, run: + + $ darcs changes --repo http://darcs.rel4tion.org/repos/smaoin + +There is also a web interface at which, among other +things, can display the history log. + +To see the log in a local clone, first get a copy of the repository if you +haven't yet: + + $ darcs get http://darcs.rel4tion.org/repos/smaoin + +Then move into the newly created directory and run darcs: + + $ cd smaoin + $ darcs changes diff --git a/INSTALL b/INSTALL new file mode 100644 --- /dev/null +++ b/INSTALL @@ -0,0 +1,13 @@ +Install from Hackage: + + $ cabal install smaoin + +Install from unpacked release tarball or source repo: + + $ cd smaoin + $ cabal install + +Just play with it without installing: + + $ cabal build + $ cabal repl diff --git a/NEWS b/NEWS new file mode 100644 --- /dev/null +++ b/NEWS @@ -0,0 +1,18 @@ +smaoin 0.1.0.0 -- 2015-05-08 +============================ + +General, build and documentation changes: + +* (This is the first release, so everything is new) + +New APIs, features and enhancements: + +* (This is the first release, so everything is a new feature) + +Bug fixes: + +* (This is the first release and there's no bug tracking yet) + +Dependency changes: + +* (No dependencies at this point) diff --git a/README b/README new file mode 100644 --- /dev/null +++ b/README @@ -0,0 +1,20 @@ +This is a small Haskell library for tagging plain text and token streams with +positions - line, column and character numbers. These are useful for locating +lexer errors, debugging and more. + +See the .cabal file for more info and link to project website the version +control. + +The official download locations are: + +- The project website +- Torrents +- Hackage + +This library is free software, and is committed to software freedom. It is +released to the public domain using the CC0 Public Domain Dedication. For the +boring "legal" details see the file 'COPYING'. + +See the file 'INSTALL' for hints on installation. The file 'ChangeLog' explains +how to see the history log of the changes done in the code. 'NEWS' provides a +friendly overview of the changes for each release. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/smaoin.cabal b/smaoin.cabal new file mode 100644 --- /dev/null +++ b/smaoin.cabal @@ -0,0 +1,46 @@ +name: smaoin +version: 0.1.0.0 +synopsis: Utilities for the Smaoin semantic information model. +description: This package provides basic types and functions for + working with the Smaoin model in Haskell. But these are + just fundamentals. Storing, loading, querying and + application level functions are/will be provided in other + packages. + . + More info about Smaoin: + . + http://rel4tion.org/projects/smaoin/ +homepage: http://rel4tion.org/projects/smaoin-hs/ +bug-reports: http://rel4tion.org/projects/smaoin-hs/tickets/ +license: PublicDomain +license-file: COPYING +author: fr33domlover +maintainer: fr33domlover@riseup.net +copyright: ♡ Copying is an act of love. Please copy, reuse and share. +category: Data +build-type: Simple +extra-source-files: AUTHORS ChangeLog COPYING INSTALL NEWS README +cabal-version: >=1.10 + +source-repository head + type: darcs + location: http://darcs.rel4tion.org/repos/smaoin/ + +library + exposed-modules: Data.Smaoin + --other-modules: + -- other-extensions: + build-depends: base ==4.7.* + , bytestring ==0.10.* + , text ==1.2.* + hs-source-dirs: src + default-language: Haskell2010 + +test-suite test + default-language: Haskell2010 + type: exitcode-stdio-1.0 + hs-source-dirs: test + main-is: test.hs + build-depends: base ==4.7.* + , QuickCheck >=2.8 + , smaoin diff --git a/src/Data/Smaoin.hs b/src/Data/Smaoin.hs new file mode 100644 --- /dev/null +++ b/src/Data/Smaoin.hs @@ -0,0 +1,127 @@ +{- This file is part of smaoin. + - + - Written in 2015 by fr33domlover . + - + - ♡ Copying is an act of love. Please copy, reuse and share. + - + - The author(s) have dedicated all copyright and related and neighboring + - rights to this software to the public domain worldwide. This software is + - distributed without any warranty. + - + - You should have received a copy of the CC0 Public Domain Dedication along + - with this software. If not, see + - . + -} + +module Data.Smaoin + ( Resource + , RealNum (..) + , Rational (..) + , Number (..) + , Value (..) + , Entity (..) + , Statement (..) + , ObjectSection (..) + , PredicateSection (..) + , StatementBlock (..) + ) +where + +import qualified Data.ByteString as BS +import qualified Data.ByteString.Lazy as BL +import Data.Ratio +import qualified Data.Text.Lazy as T + +{- +PLAN: +- set-based model (can work as list, ordered set and unordered set) +- tree-based model +- maybe graph-based model? +-} + +type Resource = BS.ByteString + +-- | Arbitrary precision real number. The first argument is the significand, +-- and the second is an exponent. @RealNum s e@ represents the number +-- @s * 10^e@. This representation allows to precisely encode any real number +-- expressed in Idan (excluding rational numbers expressed as fractions). +-- +-- While @RealNum@ is an instance of @Num@, the implementation isn't intended +-- for general math use, and is probably much simpler than what the scientific +-- Haskell packages provide. However, it is certainly suitable for basic +-- manipulations. +data RealNum = RealNum Integer Integer deriving Show + +radix :: Integer +radix = 10 + +normalize :: RealNum -> RealNum +normalize (RealNum s e) = RealNum s' e' + where + (s', e') = normalize' s e + normalize' x y = if x == 0 then (0, 0) else cleanZeros x y + cleanZeros x y = + let (d, m) = divMod x radix in + if m == 0 + then cleanZeros d (y + 1) + else (x, y) + +instance Num RealNum where + (RealNum s1 e1) + (RealNum s2 e2) = normalize $ RealNum (s1' + s2') e' + where + e' = min e1 e2 + s1' = s1 * radix ^ (e1 - e') + s2' = s2 * radix ^ (e2 - e') + + (RealNum s1 e1) * (RealNum s2 e2) = normalize $ RealNum (s1 * s2) (e1 + e2) + + abs (RealNum s e) = RealNum (abs s) e + + signum (RealNum s e) = RealNum (signum s) 0 + + fromInteger i = normalize $ RealNum i 0 + + negate (RealNum s e) = RealNum (negate s) e + +-- | A Smaoin number can be represented as a real number or as a ratio. +data Number = RealNumber RealNum | RatioNumber Rational + +data Value = Boolean Bool + | Number Number + | Character Char + | String T.Text + | Chunk BL.ByteString + | Generic T.Text Resource + +data Entity = Resource Resource | Value Value + +-- | Statements can be grouped in lists and containers to form simple +-- in-memory datastores, query results and so on. +-- +-- Parameters are: Identifier, subject, predicate, object. +data Statement = Statement Resource Resource Resource Entity + +-- An object section is attached to subjects and predicated to form +-- statements. It contains the object of a statement, and the identifier that +-- the resulting statement would have, once attached to a subject and a +-- predicate. +-- +-- Parameters are: Object, identifier. +data ObjectSection = ObjectSection Entity Resource + +-- | A predicate section is meant to be attached to a subject. It describes it +-- through one or more statements. It expresses predicate-object-identifier +-- triples. But instead of repeating predicates, it gives each predicate its +-- own set of object-identifier pairs. +-- +-- Parameters: Predicate; Objects and identifiers. +data PredicateSection = PredicateSection Resource [ObjectSection] + +-- | A statement block describes a single subject, by expressing one or more +-- statements which share that subject. The predicate sections contain the +-- predicates, objects and identifiers. With the subject attached, they form +-- statements. Statement blocks can be grouped in lists and countainers to form +-- simple in-memory datastores, query results and so on. +-- +-- Parameters: 1) Subject; 2) Predicates, objects, identifiers. +data StatementBlock = StatementBlock Resource [PredicateSection] diff --git a/test/test.hs b/test/test.hs new file mode 100644 --- /dev/null +++ b/test/test.hs @@ -0,0 +1,33 @@ +{- This file is part of smaoin. + - + - Written in 2015 by fr33domlover . + - + - ♡ Copying is an act of love. Please copy, reuse and share. + - + - The author(s) have dedicated all copyright and related and neighboring + - rights to this software to the public domain worldwide. This software is + - distributed without any warranty. + - + - You should have received a copy of the CC0 Public Domain Dedication along + - with this software. If not, see + - . + -} + +import Control.Monad (unless) +import System.Exit +import Test.QuickCheck +import Test.QuickCheck.Test +import Text.Printf + +main :: IO () +main = do + results <- mapM (\ (name ,action) -> printf "%-25s: " name >> action) tests + unless (all isSuccess results) exitFailure + +prop_todo :: Bool +prop_todo = False + +tests :: [(String, IO Result)] +tests = + [ ("todo", quickCheckResult prop_todo) + ]