From 2ba8355fb182ed60589209e5350b339508fdaf82 Mon Sep 17 00:00:00 2001 From: xecarlox94 Date: Tue, 3 Dec 2024 00:33:28 +0000 Subject: [PATCH] finished first version of documentation --- Docs/haskell/P2PRC.html | 36 ++ Docs/haskell/P2PRC.md | 120 ++++ Docs/haskell/README.md | 120 ++++ Docs/haskell/doc-index.html | 1 + Docs/haskell/doc-index.md | 30 + Docs/haskell/haddock-bundle.min.js | 2 + Docs/haskell/index.html | 1 + Docs/haskell/index.md | 44 ++ Docs/haskell/linuwial.css | 881 +++++++++++++++++++++++++++++ Docs/haskell/meta.json | 1 + Docs/haskell/p2prc.haddock | Bin 0 -> 5515 bytes Docs/haskell/quick-jump.css | 221 ++++++++ Docs/haskell/synopsis.png | Bin 0 -> 11327 bytes haskell/gen_docs.sh | 9 + haskell/lib/API.hs | 20 +- haskell/lib/Engine.hs | 4 +- haskell/lib/JSON.hs | 77 +-- haskell/lib/P2PRC.hs | 8 +- 18 files changed, 1528 insertions(+), 47 deletions(-) create mode 100644 Docs/haskell/P2PRC.html create mode 100644 Docs/haskell/P2PRC.md create mode 100644 Docs/haskell/README.md create mode 100644 Docs/haskell/doc-index.html create mode 100644 Docs/haskell/doc-index.md create mode 100644 Docs/haskell/haddock-bundle.min.js create mode 100644 Docs/haskell/index.html create mode 100644 Docs/haskell/index.md create mode 100644 Docs/haskell/linuwial.css create mode 100644 Docs/haskell/meta.json create mode 100644 Docs/haskell/p2prc.haddock create mode 100644 Docs/haskell/quick-jump.css create mode 100644 Docs/haskell/synopsis.png create mode 100755 haskell/gen_docs.sh diff --git a/Docs/haskell/P2PRC.html b/Docs/haskell/P2PRC.html new file mode 100644 index 0000000..9c67729 --- /dev/null +++ b/Docs/haskell/P2PRC.html @@ -0,0 +1,36 @@ +P2PRC
p2prc-0.1.0.0: P2PRC haskell library
CopyrightCopyright (C) 2024-2024 Jose Fernandes
LicenseGNU GPL, version 2 or above
MaintainerJose Fernandes <jf94.uk@gmail.com>
Stabilitybeta
Portabilityportable
Safe HaskellSafe-Inferred
LanguageGHC2021

P2PRC

Description

This library provides an interface to the P2Prc runtime.

This Module intends to export the main functions and data type definitions necessary to get started with the P2PRC api.

A minimal application will require the import of runP2PRC function that accepts a MapPortRequest value that exposes a specific port number and associates it with a domain name in the internet.

This is a small template to get quickly get started with this interface. We assume the user has already an application listening on the tcp socket "8080".

module Main where
+
+import P2PRC
+  ( runP2PRC
+  , MapPortRequest(MkMapPortRequest)
+  )
+
+main :: IO ()
+main =
+  runP2PRC
+    ( MkMapPortRequest 8080 "jose.akilan.io"
+    )

Functions

These are the available functions available to interact with the P2Prc environment, at a lower level of abstraction. + It is intended this way to give freedom to the developer to implement their own orchestration strategies.

runP2PRC #

Arguments

:: MapPortRequest

TCP Port Request

-> IO () 

This function starts and bootstraps the P2PRC runtime that associates the a specific host's machine port to a DNS address to expose a certain application to the P2PRC network. You will only need to also import the MkMapPortRequest data constructor to represent the this port request.

Example

Expand

This example demonstrates how it can be ran on the IO context:

 example :: IO ()
+ example = do
+   runP2PRC
+     ( MkMapPortRequest 8080 "jose.akilan.io"
+     )
+

getP2prcAPI :: IOEitherError P2PRCapi #

Warning: This function is currently unstable since it assumes that the Haskell program is executed from the P2PRC "haskell" subfolder and the "p2prc" executable in the the root folder.

This function cleans the previous running state (ensuring a pure P2PRC runtime state) and builds up a conditional P2PRCapi instance.

Example

Expand

The following example show how this function can be used to expose the runtime functionalities:

 example :: IOEitherError P2PRCapi
+ example = do
+
+   eitherP2prcAPI <- getP2prcAPI
+
+   case eitherP2prcAPI of
+     ( Right
+       ( MkP2PRCapi
+         { startServer     = startServer
+         , execInitConfig  = execInitConfig
+         , execListServers = execListServers
+         , execMapPort     = execMapPort
+         }
+       )) -> do
+
+       -- Your code logic
+
+     errValue -> errValue
+

Data Types

This section describes and explains the library's type system, more specifically, the interfaces and primitive types.

Interface data types

This section gives an overview on the runtime and host machine interfaces.

data P2PRCapi #

Lower level P2PRC Haskell api that exposes basic functionality necessary to joint the network.

Constructors

MkP2PRCapi 

Fields

newtype P2prcConfig #

Warning: This type is unstable at the moment due to the P2PRC's library error handling bug. For more information visit: https://github.com/Akilan1999/p2p-rendering-computation/issues/114#issuecomment-2474737015

This represents the server configuration that defines its attributes and behaviours in the network, as well as, the location of the runtime persistence artifacts.

Constructors

MkP2prConfig 

Fields

Instances

Instances details
FromJSON P2prcConfig # 
Instance details

Defined in JSON

Methods

parseJSON :: Value -> Parser P2prcConfig #

parseJSONList :: Value -> Parser [P2prcConfig] #

omittedField :: Maybe P2prcConfig #

Show P2prcConfig # 
Instance details

Defined in JSON

Methods

showsPrec :: Int -> P2prcConfig -> ShowS #

show :: P2prcConfig -> String #

showList :: [P2prcConfig] -> ShowS #

data MapPortRequest #

This defines the request required to create an association between a TCP socket port and a DNS server in the network. If successful, it makes a resource available in the network.

Constructors

MkMapPortRequest

P2PRC's port allocation request value

Fields

  • Int

    TCP socket number

  • String

    Network domain name

newtype MapPortResponse #

Warning: This newtype is unstable at the moment due to the P2PRC's library error handling bug. For more information visit: https://github.com/Akilan1999/p2p-rendering-computation/issues/114#issuecomment-2474737015

This represents P2PRC's response to the TCP port and DNS address allocation. This value will confirm the successful allocation and return information about it.

Constructors

MkMapPortResponse

Allocation information value

Fields

  • String

    Column separated Host's IP address and Port String

Instances

Instances details
FromJSON MapPortResponse # 
Instance details

Defined in JSON

Methods

parseJSON :: Value -> Parser MapPortResponse #

parseJSONList :: Value -> Parser [MapPortResponse] #

omittedField :: Maybe MapPortResponse #

Show MapPortResponse # 
Instance details

Defined in JSON

Methods

showsPrec :: Int -> MapPortResponse -> ShowS #

show :: MapPortResponse -> String #

showList :: [MapPortResponse] -> ShowS #

Primitive data types

These types represent the core data that is communicated between requests and the runtime.

newtype IPAddressTable #

Warning: This newtype is highly unstable due to undergoing work on improving P2PRC's server api. For more information, visit: https://github.com/Akilan1999/p2p-rendering-computation/issues/114

This is a wrapper value that parses a json key value from the list of ip addresses in the network.

Constructors

MkIPAddressTable

Wrapping constructor

Fields

Instances

Instances details
FromJSON IPAddressTable # 
Instance details

Defined in JSON

Methods

parseJSON :: Value -> Parser IPAddressTable #

parseJSONList :: Value -> Parser [IPAddressTable] #

omittedField :: Maybe IPAddressTable #

Show IPAddressTable # 
Instance details

Defined in JSON

Methods

showsPrec :: Int -> IPAddressTable -> ShowS #

show :: IPAddressTable -> String #

showList :: [IPAddressTable] -> ShowS #

data ServerInfo #

Warning: This type is highly unstable due to undergoing work on improving P2PRC's server api. For more information, visit: https://github.com/Akilan1999/p2p-rendering-computation/issues/114

This is a record that keeps track of the current state of every node in the network. It is crucial information required for orchestration strategies.

Constructors

MkServerInfo 

Fields

Instances

Instances details
FromJSON ServerInfo # 
Instance details

Defined in JSON

Methods

parseJSON :: Value -> Parser ServerInfo #

parseJSONList :: Value -> Parser [ServerInfo] #

omittedField :: Maybe ServerInfo #

Show ServerInfo # 
Instance details

Defined in JSON

Methods

showsPrec :: Int -> ServerInfo -> ShowS #

show :: ServerInfo -> String #

showList :: [ServerInfo] -> ShowS #

data IPAddress #

This is a simple representation of the IP address of nodes in the network.

Constructors

MkIPv4 String

IP version 4 address

MkIPv6 String

IP version 6 address

Instances

Instances details
Show IPAddress # 
Instance details

Defined in JSON

Methods

showsPrec :: Int -> IPAddress -> ShowS #

show :: IPAddress -> String #

showList :: [IPAddress] -> ShowS #

data Error #

Haskell-side Error value. This type is designed to parse and track System and P2PRC's error signals in a safe and effective manner.

It does have an MkUnknownError value which is meant to be warn about new kinds of error not yet accounted in this client. Github issues and pull requests are very welcome to improve error handling by parsing more types of errors.

Constructors

MkCLISystemError

This is a CLI System Error

Fields

MkErrorSpawningProcess

Spawing process error

Fields

  • String

    Spawning executable name

MkUnknownError

This is an unparsed P2PRC's error

Fields

Instances

Instances details
Show Error # 
Instance details

Defined in Error

Methods

showsPrec :: Int -> Error -> ShowS #

show :: Error -> String #

showList :: [Error] -> ShowS #

Type Synonyms

This section is reserved to some useful type synonyms that add significant ergonomics.

type IOEitherError a = IO (Either Error a) #

Type synonym for an IO action with either returns an Error or a parsed value

\ No newline at end of file diff --git a/Docs/haskell/P2PRC.md b/Docs/haskell/P2PRC.md new file mode 100644 index 0000000..a5c96dd --- /dev/null +++ b/Docs/haskell/P2PRC.md @@ -0,0 +1,120 @@ +
+ +p2prc-0.1.0.0: P2PRC haskell library + +- [Contents](index.html) +- [Index](doc-index.html) + +
+ +
+ +
+ +| | | +|--------------|-----------------------------------------| +| Copyright | Copyright (C) 2006-2024 John MacFarlane | +| License | GNU GPL, version 2 or above | +| Maintainer | John MacFarlane \ | +| Stability | alpha | +| Portability | portable | +| Safe Haskell | Safe-Inferred | +| Language | GHC2021 | + +P2PRC + +
+ +
+ +Description + +
+ +This helper module exports the main writers, readers, and data structure +definitions from the Pandoc libraries. + +A typical application will chain together a reader and a writer to +convert strings from one format to another. For example, the following +simple program will act as a filter converting markdown fragments to +reStructuredText, using reference-style links instead of inline links: + + module Main where + import Text.Pandoc + import Data.Text (Text) + import qualified Data.Text.IO as T + + mdToRST :: Text -> IO Text + mdToRST txt = runIOorExplode $ + readMarkdown def txt + >>= writeRST def{ writerReferenceLinks = True } + + main :: IO () + main = do + T.getContents >>= mdToRST >>= T.putStrLn + +
+ +
+ +
+ +Synopsis + +- [runP2PRC](#v:runP2PRC) :: + [MapPortRequest](P2PRC.html#t:MapPortRequest "P2PRC") -\> + [IO]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/System-IO.html#t:IO "System.IO") + () +- data [MapPortRequest](#t:MapPortRequest) + = [MkMapPortRequest](#v:MkMapPortRequest) + [Int]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/Data-Int.html#t:Int "Data.Int") + [String]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/Data-String.html#t:String "Data.String") + +
+ +
+ +# Documentation + +
+ +runP2PRC :: +[MapPortRequest](P2PRC.html#t:MapPortRequest "P2PRC") -\> +[IO]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/System-IO.html#t:IO "System.IO") +() # + +
+ +Hello World + +
+ +
+ +
+ +data MapPortRequest +# + +
+ +Constructors + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| MkMapPortRequest [Int]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/Data-Int.html#t:Int "Data.Int") [String]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/Data-String.html#t:String "Data.String") |   | + +
+ +
+ +
+ +
+ + diff --git a/Docs/haskell/README.md b/Docs/haskell/README.md new file mode 100644 index 0000000..a5c96dd --- /dev/null +++ b/Docs/haskell/README.md @@ -0,0 +1,120 @@ +
+ +p2prc-0.1.0.0: P2PRC haskell library + +- [Contents](index.html) +- [Index](doc-index.html) + +
+ +
+ +
+ +| | | +|--------------|-----------------------------------------| +| Copyright | Copyright (C) 2006-2024 John MacFarlane | +| License | GNU GPL, version 2 or above | +| Maintainer | John MacFarlane \ | +| Stability | alpha | +| Portability | portable | +| Safe Haskell | Safe-Inferred | +| Language | GHC2021 | + +P2PRC + +
+ +
+ +Description + +
+ +This helper module exports the main writers, readers, and data structure +definitions from the Pandoc libraries. + +A typical application will chain together a reader and a writer to +convert strings from one format to another. For example, the following +simple program will act as a filter converting markdown fragments to +reStructuredText, using reference-style links instead of inline links: + + module Main where + import Text.Pandoc + import Data.Text (Text) + import qualified Data.Text.IO as T + + mdToRST :: Text -> IO Text + mdToRST txt = runIOorExplode $ + readMarkdown def txt + >>= writeRST def{ writerReferenceLinks = True } + + main :: IO () + main = do + T.getContents >>= mdToRST >>= T.putStrLn + +
+ +
+ +
+ +Synopsis + +- [runP2PRC](#v:runP2PRC) :: + [MapPortRequest](P2PRC.html#t:MapPortRequest "P2PRC") -\> + [IO]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/System-IO.html#t:IO "System.IO") + () +- data [MapPortRequest](#t:MapPortRequest) + = [MkMapPortRequest](#v:MkMapPortRequest) + [Int]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/Data-Int.html#t:Int "Data.Int") + [String]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/Data-String.html#t:String "Data.String") + +
+ +
+ +# Documentation + +
+ +runP2PRC :: +[MapPortRequest](P2PRC.html#t:MapPortRequest "P2PRC") -\> +[IO]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/System-IO.html#t:IO "System.IO") +() # + +
+ +Hello World + +
+ +
+ +
+ +data MapPortRequest +# + +
+ +Constructors + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| MkMapPortRequest [Int]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/Data-Int.html#t:Int "Data.Int") [String]($%7Bpkgroot%7D/../../../../dcnyq1a8qi8x59n5p53d0dx42cl8hf8x-ghc-9.6.5-doc/share/doc/ghc/html/libraries/base-4.18.2.1/Data-String.html#t:String "Data.String") |   | + +
+ +
+ +
+ +
+ + diff --git a/Docs/haskell/doc-index.html b/Docs/haskell/doc-index.html new file mode 100644 index 0000000..f5cfe01 --- /dev/null +++ b/Docs/haskell/doc-index.html @@ -0,0 +1 @@ +p2prc-0.1.0.0: P2PRC haskell library (Index)
p2prc-0.1.0.0: P2PRC haskell library

Index

bareMetalSSHPortP2PRC
customInformationP2PRC
downloadP2PRC
ErrorP2PRC
escapeImplementationP2PRC
execInitConfigP2PRC
execListServersP2PRC
execMapPortP2PRC
getP2prcAPIP2PRC
IOEitherErrorP2PRC
ipP2PRC
IPAddressP2PRC
IPAddressTableP2PRC
latencyP2PRC
machineNameP2PRC
MapPortRequestP2PRC
MapPortResponseP2PRC
MkCLISystemErrorP2PRC
MkErrorSpawningProcessP2PRC
MkIPAddressTableP2PRC
MkIPv4P2PRC
MkIPv6P2PRC
MkMapPortRequestP2PRC
MkMapPortResponseP2PRC
MkP2PRCapiP2PRC
MkP2prConfigP2PRC
MkServerInfoP2PRC
MkUnknownErrorP2PRC
nameP2PRC
natP2PRC
P2PRCapiP2PRC
P2prcConfigP2PRC
runP2PRCP2PRC
ServerInfoP2PRC
serverPortP2PRC
startServerP2PRC
uploadP2PRC
\ No newline at end of file diff --git a/Docs/haskell/doc-index.md b/Docs/haskell/doc-index.md new file mode 100644 index 0000000..11b10db --- /dev/null +++ b/Docs/haskell/doc-index.md @@ -0,0 +1,30 @@ +
+ +p2prc-0.1.0.0: P2PRC haskell library + +- [Contents](index.html) +- [Index](doc-index.html) + +
+ +
+ +
+ +Index + +| | | +|------------------|------------------------------------------------| +| MapPortRequest | [P2PRC](P2PRC.html#t:MapPortRequest "P2PRC") | +| MkMapPortRequest | [P2PRC](P2PRC.html#v:MkMapPortRequest "P2PRC") | +| runP2PRC | [P2PRC](P2PRC.html#v:runP2PRC "P2PRC") | + +
+ +
+ + diff --git a/Docs/haskell/haddock-bundle.min.js b/Docs/haskell/haddock-bundle.min.js new file mode 100644 index 0000000..4b2fa13 --- /dev/null +++ b/Docs/haskell/haddock-bundle.min.js @@ -0,0 +1,2 @@ +!function i(s,a,l){function c(t,e){if(!a[t]){if(!s[t]){var n="function"==typeof require&&require;if(!e&&n)return n(t,!0);if(u)return u(t,!0);var o=new Error("Cannot find module '"+t+"'");throw o.code="MODULE_NOT_FOUND",o}var r=a[t]={exports:{}};s[t][0].call(r.exports,function(e){return c(s[t][1][e]||e)},r,r.exports,i,s,a,l)}return a[t].exports}for(var u="function"==typeof require&&require,e=0;e element with id '"+e+"'");return t}function x(){return u.defaultInstanceState==i.Open}function w(e){for(var t=S(e.target.id),n=t.element.open,o=0,r=t.toggles;owindow.innerHeight?this.searchResults.scrollTop+=e.bottom-window.innerHeight+80:e.topn)return u(e,this.pattern,o);var r=this.options,i=r.location,s=r.distance,a=r.threshold,l=r.findAllMatches,c=r.minMatchCharLength;return d(e,this.pattern,this.patternAlphabet,{location:i,distance:s,threshold:a,findAllMatches:l,minMatchCharLength:c})}}]),y}();e.exports=r},function(e,t,n){"use strict";var u=n(0);e.exports=function(e,t){return function e(t,n,o){if(n){var r=n.indexOf("."),i=n,s=null;-1!==r&&(i=n.slice(0,r),s=n.slice(r+1));var a=t[i];if(null!=a)if(s||"string"!=typeof a&&"number"!=typeof a)if(u(a))for(var l=0,c=a.length;l 0 and <= 1");p=p.name}else a[p]={weight:1};this._analyze({key:p,value:this.options.getFn(u,p),record:u,index:l},{resultMap:o,results:r,tokenSearchers:e,fullSearcher:t})}return{weights:a,results:r}}},{key:"_analyze",value:function(e,t){var n=e.key,o=e.arrayIndex,r=void 0===o?-1:o,i=e.value,s=e.record,a=e.index,l=t.tokenSearchers,c=void 0===l?[]:l,u=t.fullSearcher,d=void 0===u?[]:u,h=t.resultMap,p=void 0===h?{}:h,f=t.results,v=void 0===f?[]:f;if(null!=i){var g=!1,m=-1,y=0;if("string"==typeof i){this._log("\nKey: "+(""===n?"-":n));var _=d.search(i);if(this._log('Full text: "'+i+'", score: '+_.score),this.options.tokenize){for(var b=i.split(this.options.tokenSeparator),k=[],S=0;S=c.length;if(this._log("\nCheck Matches: "+T),(g||_.isMatch)&&T){var N=p[a];N?N.output.push({key:n,arrayIndex:r,value:i,score:A,matchedIndices:_.matchedIndices}):(p[a]={item:s,output:[{key:n,arrayIndex:r,value:i,score:A,matchedIndices:_.matchedIndices}]},v.push(p[a]))}}else if(V(i))for(var P=0,j=i.length;Pp2prc-0.1.0.0: P2PRC haskell library
p2prc-0.1.0.0: P2PRC haskell library

p2prc-0.1.0.0: P2PRC haskell library

Implements a client interface to the P2PRC networking runtime

Modules

p2prc-0.1.0.0

\ No newline at end of file diff --git a/Docs/haskell/index.md b/Docs/haskell/index.md new file mode 100644 index 0000000..5a74ed5 --- /dev/null +++ b/Docs/haskell/index.md @@ -0,0 +1,44 @@ +
+ +p2prc-0.1.0.0: P2PRC haskell library + +- [Contents](index.html) +- [Index](doc-index.html) + +
+ +
+ +
+ +# p2prc-0.1.0.0: P2PRC haskell library + +
+ +Implements a client interface to the P2PRC networking runtime + +
+ +
+ +
+ +Modules + +
+ +p2prc-0.1.0.0 + +-  [P2PRC](P2PRC.html) + +
+ +
+ +
+ + diff --git a/Docs/haskell/linuwial.css b/Docs/haskell/linuwial.css new file mode 100644 index 0000000..4164b84 --- /dev/null +++ b/Docs/haskell/linuwial.css @@ -0,0 +1,881 @@ +/* @group Fundamentals */ + +* { margin: 0; padding: 0 } + +/* Is this portable? */ +html { + background-color: white; + width: 100%; + height: 100%; +} + +body { + background: #fefefe; + color: #111; + text-align: left; + min-height: 100vh; + position: relative; + -webkit-text-size-adjust: 100%; + -webkit-font-feature-settings: "kern" 1, "liga" 0; + -moz-font-feature-settings: "kern" 1, "liga" 0; + -o-font-feature-settings: "kern" 1, "liga" 0; + font-feature-settings: "kern" 1, "liga" 0; + letter-spacing: 0.0015rem; +} + +#content a { + overflow-wrap: break-word; +} + +p { + margin: 0.8em 0; +} + +ul, ol { + margin: 0.8em 0 0.8em 2em; +} + +dl { + margin: 0.8em 0; +} + +dt { + font-weight: bold; +} +dd { + margin-left: 2em; +} + +a { text-decoration: none; } +a[href]:link { color: #9E358F; } +a[href]:visited {color: #6F5F9C; } +a[href]:hover { text-decoration:underline; } + +a[href].def:link, a[href].def:visited { color: rgba(69, 59, 97, 0.8); } +a[href].def:hover { color: rgb(78, 98, 114); } + +/* @end */ + +/* @group Show and hide with JS */ + +body.js-enabled .hide-when-js-enabled { + display: none; +} + +/* @end */ + + +/* @group responsive */ + +#package-header .caption { + margin: 0px 1em 0 2em; +} + +@media only screen and (min-width: 1280px) { + #content { + width: 63vw; + max-width: 1450px; + } + + #table-of-contents { + position: fixed; + max-width: 10vw; + top: 10.2em; + left: 2em; + bottom: 1em; + overflow-y: auto; + } + + #synopsis { + display: block; + position: fixed; + float: left; + top: 5em; + bottom: 1em; + right: 0; + max-width: 65vw; + overflow-y: auto; + /* Ensure that synopsis covers everything (including MathJAX markup) */ + z-index: 1; + } + + #synopsis .show { + border: 1px solid #5E5184; + padding: 0.7em; + max-height: 65vh; + } + +} + +@media only screen and (max-width: 1279px) { + #content { + width: 80vw; + } + + #synopsis { + display: block; + padding: 0; + position: relative; + margin: 0; + width: 100%; + } +} + +@media only screen and (max-width: 999px) { + #content { + width: 93vw; + } +} + + +/* menu for wider screens + + Display the package name at the left and the menu links at the right, + inline with each other: + The package name Source . Contents . Index +*/ +@media only screen and (min-width: 1000px) { + #package-header { + text-align: left; + white-space: nowrap; + height: 40px; + padding: 4px 1.5em 0px 1.5em; + overflow: visible; + + display: flex; + justify-content: space-between; + align-items: center; + } + + #package-header .caption { + display: inline-block; + margin: 0; + } + + #package-header ul.links { + margin: 0; + display: inline-table; + } + + #package-header .caption + ul.links { + margin-left: 1em; + } +} + +/* menu for smaller screens + +Display the package name on top of the menu links and center both elements: + The package name + Source . Contents . Index +*/ +@media only screen and (max-width: 999px) { + #package-header { + text-align: center; + padding: 6px 0 4px 0; + overflow: hidden; + } + + #package-header ul.links { + display: block; + text-align: center; + margin: 0; + + /* Hide scrollbar but allow scrolling menu links horizontally */ + white-space: nowrap; + overflow-x: auto; + overflow-y: hidden; + margin-bottom: -17px; + height: 50px; + } + + #package-header .caption { + display: block; + margin: 4px 0; + text-align: center; + } + + #package-header ul.links::-webkit-scrollbar { + display: none; + } + + #package-header ul.links li:first-of-type { + padding-left: 1em; + } + + #package-header ul.links li:last-of-type { + /* + The last link of the menu should offer the same distance to the right + as the #package-header enforces at the left. + */ + padding-right: 1em; + } + + #package-header .caption + ul.links { + padding-top: 9px; + } + + #module-header table.info { + float: none; + top: 0; + margin: 0 auto; + overflow: hidden; + max-width: 80vw; + } +} + +/* @end */ + + +/* @group Fonts & Sizes */ + +/* Basic technique & IE workarounds from YUI 3 + For reasons, see: + http://yui.yahooapis.com/3.1.1/build/cssfonts/fonts.css + */ + + body, button { + font: 400 14px/1.4 'PT Sans', + /* Fallback Font Stack */ + -apple-system, + BlinkMacSystemFont, + 'Segoe UI', + Roboto, + Oxygen-Sans, + Cantarell, + 'Helvetica Neue', + sans-serif; + *font-size: medium; /* for IE */ + *font:x-small; /* for IE in quirks mode */ + } + +h1 { font-size: 146.5%; /* 19pt */ } +h2 { font-size: 131%; /* 17pt */ } +h3 { font-size: 116%; /* 15pt */ } +h4 { font-size: 100%; /* 13pt */ } +h5 { font-size: 100%; /* 13pt */ } + +table { + font-size:inherit; + font:100%; +} + +pre, code, kbd, samp, tt, .src { + font-family:monospace; +} + +.links, .link { + font-size: 85%; /* 11pt */ +} + +#module-header .caption { + font-size: 182%; /* 24pt */ +} + +#module-header .caption sup { + font-size: 80%; + font-weight: normal; +} + +#package-header #page-menu a:link, #package-header #page-menu a:visited { color: white; } + + +.info { + font-size: 90%; +} + + +/* @end */ + +/* @group Common */ + +.caption, h1, h2, h3, h4, h5, h6, summary { + font-weight: bold; + color: #5E5184; + margin: 1.5em 0 1em 0; +} + + +* + h1, * + h2, * + h3, * + h4, * + h5, * + h6 { + margin-top: 2em; +} + +h1 + h2, h2 + h3, h3 + h4, h4 + h5, h5 + h6 { + margin-top: inherit; +} + +ul li + li { + margin-top: 0.2rem; +} + +ul + p { + margin-top: 0.93em; +} + +p + ul { + margin-top: 0.5em; +} + +p { + margin-top: 0.7rem; +} + +ul, ol { + margin: 0.8em 0 0.8em 2em; +} + +ul.links { + list-style: none; + text-align: left; + font-size: 0.95em; +} + +#package-header ul.links, #package-header ul.links button { + font-size: 1rem; +} + +ul.links li { + display: inline; + white-space: nowrap; + padding: 0; +} + +ul.links > li + li:before { + content: '\00B7'; +} + +ul.links li a { + padding: 0.2em 0.5em; +} + +.hide { display: none; } +.show { display: inherit; } +.clear { clear: both; } + +.collapser:before, .expander:before, .noexpander:before { + font-size: 1.2em; + color: #9C5791; + display: inline-block; + padding-right: 7px; +} + +.collapser:before { + content: '▿'; +} +.expander:before { + content: '▹'; +} +.noexpander:before { + content: '▿'; + visibility: hidden; +} + +.collapser, .expander { + cursor: pointer; +} + +.instance.collapser, .instance.expander { + margin-left: 0px; + background-position: left center; + min-width: 9px; + min-height: 9px; +} + +summary { + cursor: pointer; + outline: none; +} + +pre { + padding: 0.5rem 1rem; + margin: 1em 0 0 0; + background-color: #f7f7f7; + overflow: auto; + border: 1px solid #ddd; + border-radius: 0.3em; +} + +pre + p { + margin-top: 1em; +} + +pre + pre { + margin-top: 0.5em; +} + +blockquote { + border-left: 3px solid #c7a5d3; + background-color: #eee4f1; + margin: 0.5em; + padding: 0.0005em 0.3em 0.5em 0.5em; +} + +.src { + background: #f2f2f2; + padding: 0.2em 0.5em; +} + +.keyword { font-weight: normal; } +.def { font-weight: bold; } + +@media print { + #footer { display: none; } +} + +/* @end */ + +/* @group Page Structure */ + +#content { + margin: 3em auto 6em auto; + padding: 0; +} + +#package-header { + background: #5E5184; + border-bottom: 5px solid rgba(69, 59, 97, 0.5); + color: #ddd; + position: relative; + font-size: 1.2em; + text-align: left; + margin: 0 auto; +} + +#package-header .caption { + color: white; + font-style: normal; + font-size: 1rem; + font-weight: bold; +} + +#module-header .caption { + font-weight: bold; + border-bottom: 1px solid #ddd; +} + +table.info { + float: right; + padding: 0.5em 1em; + border: 1px solid #ddd; + color: rgb(78,98,114); + background-color: #fff; + max-width: 60%; + border-spacing: 0; + position: relative; + top: -0.78em; + margin: 0 0 0 2em; +} + +.info th { + padding: 0 1em 0 0; + text-align: right; +} + +#style-menu li { + display: block; + border-style: none; + list-style-type: none; +} + +#footer { + background: #ededed; + border-top: 1px solid #aaa; + padding: 0.5em 0; + color: #222; + text-align: center; + width: 100%; + height: 3em; + margin-top: 3em; + position: relative; + clear: both; +} + +/* @end */ + +/* @group Front Matter */ + +#synopsis .caption, +#contents-list .caption { + font-size: 1rem; +} + +#synopsis, #table-of-contents { + font-size: 16px; +} + +#contents-list { + background: #f4f4f4; + padding: 1em; + margin: 0; +} + +#contents-list .caption { + text-align: left; + margin: 0; +} + +#contents-list ul { + list-style: none; + margin: 0; + margin-top: 10px; + font-size: 14px; +} + +#contents-list ul ul { + margin-left: 1.5em; +} + +#description .caption { + display: none; +} + +#synopsis summary { + display: block; + float: right; + width: 29px; + color: rgba(255,255,255,0); + height: 110px; + margin: 0; + font-size: 1px; + padding: 0; + background: url(synopsis.png) no-repeat 0px -8px; +} + +#synopsis details[open] > summary { + background: url(synopsis.png) no-repeat -75px -8px; +} + +#synopsis details:not([open]) > ul { + visibility: hidden; +} + +#synopsis ul { + height: 100%; + overflow: auto; + padding: 0.5em; + margin: 0; +} + +#synopsis ul ul { + overflow: hidden; +} + +#synopsis ul, +#synopsis ul li.src { + background-color: rgb(250,247,224); + white-space: nowrap; + list-style: none; + margin-left: 0; +} + +#interface td.src { + white-space: nowrap; +} + +/* @end */ + +/* @group Main Content */ + +#interface div.top + div.top { + margin-top: 1.5em; +} + +#interface p + div.top, +#interface h1 + div.top, +#interface h2 + div.top, +#interface h3 + div.top, +#interface h4 + div.top, +#interface h5 + div.top { + margin-top: 1em; +} +#interface .src .selflink, +#interface .src .link { + float: right; + color: #888; + padding: 0 7px; + -moz-user-select: none; + font-weight: bold; + line-height: 30px; +} +#interface .src .selflink { + margin: 0 -0.5em 0 0.5em; +} + +#interface span.fixity { + color: #919191; + border-left: 1px solid #919191; + padding: 0.2em 0.5em 0.2em 0.5em; + margin: 0 -1em 0 1em; +} + +#interface span.rightedge { + border-left: 1px solid #919191; + padding: 0.2em 0 0.2em 0; + margin: 0 0 0 1em; +} + +#interface table { border-spacing: 2px; } +#interface td { + vertical-align: top; + padding-left: 0.5em; +} + +#interface td.doc p { + margin: 0; +} +#interface td.doc p + p { + margin-top: 0.8em; +} + +.doc table { + border-collapse: collapse; + border-spacing: 0px; +} + +.doc th, +.doc td { + padding: 5px; + border: 1px solid #ddd; +} + +.doc th { + background-color: #f0f0f0; +} + +.clearfix:after { + clear: both; + content: " "; + display: block; + height: 0; + visibility: hidden; +} + +.subs, .top > .doc, .subs > .doc { + padding-left: 1em; + border-left: 1px solid gainsboro; + margin-bottom: 1em; +} + +.top .subs { + margin-bottom: 0.6em; +} + +.subs.fields ul { + list-style: none; + display: table; + margin: 0; +} + +.subs.fields ul li { + display: table-row; +} + +.subs ul li dfn { + display: table-cell; + font-style: normal; + font-weight: bold; + margin: 1px 0; + white-space: nowrap; +} + +.subs ul li > .doc { + display: table-cell; + padding-left: 0.5em; + margin-bottom: 0.5em; +} + +.subs ul li > .doc p { + margin: 0; +} + +.subs .subs p.src { + border: none; + background-color: #f8f8f8; +} + +.subs .subs .caption { + margin-top: 1em ; + margin-bottom: 0px; +} + +.subs p.caption { + margin-top: 0; +} + +.subs .subs .caption + .src { + margin: 0px; + margin-top: 8px; +} + +.subs .subs .src + .src { + margin: 7px 0 0 0; +} + +/* Render short-style data instances */ +.inst ul { + height: 100%; + padding: 0.5em; + margin: 0; +} + +.inst, .inst li { + list-style: none; + margin-left: 1em; +} + +/* Workaround for bug in Firefox (issue #384) */ +.inst-left { + float: left; +} + +.top p.src { + border-bottom: 3px solid #e5e5e5; + line-height: 2rem; + margin-bottom: 1em; +} + +.warning { + color: red; +} + +.arguments { + margin-top: -0.4em; +} +.arguments .caption { + display: none; +} + +.fields { padding-left: 1em; } + +.fields .caption { display: none; } + +.fields p { margin: 0 0; } + +/* this seems bulky to me +.methods, .constructors { + background: #f8f8f8; + border: 1px solid #eee; +} +*/ + +/* @end */ + +/* @group Auxillary Pages */ + + +.extension-list { + list-style-type: none; + margin-left: 0; +} + +#mini { + margin: 0 auto; + padding: 0 1em 1em; +} + +#mini > * { + font-size: 93%; /* 12pt */ +} + +#mini #module-list .caption, +#mini #module-header .caption { + font-size: 125%; /* 15pt */ +} + +#mini #interface h1, +#mini #interface h2, +#mini #interface h3, +#mini #interface h4 { + font-size: 109%; /* 13pt */ + margin: 1em 0 0; +} + +#mini #interface .top, +#mini #interface .src { + margin: 0; +} + +#mini #module-list ul { + list-style: none; + margin: 0; +} + +#alphabet ul { + list-style: none; + padding: 0; + margin: 0.5em 0 0; + text-align: center; +} + +#alphabet li { + display: inline; + margin: 0 0.25em; +} + +#alphabet a { + font-weight: bold; +} + +#index .caption, +#module-list .caption { font-size: 131%; /* 17pt */ } + +#index table { + margin-left: 2em; +} + +#index .src { + font-weight: bold; +} +#index .alt { + font-size: 77%; /* 10pt */ + font-style: italic; + padding-left: 2em; +} + +#index td + td { + padding-left: 1em; +} + +#module-list ul { + list-style: none; + margin: 0 0 0 2em; +} + +#module-list li { + clear: right; +} + +#module-list span.collapser, +#module-list span.expander { + background-position: 0 0.3em; +} + +#module-list .package { + float: right; +} + +:target { + background: -webkit-linear-gradient(top, transparent 0%, transparent 65%, #fbf36d 60%, #fbf36d 100%); + background: -moz-linear-gradient(top, transparent 0%, transparent 65%, #fbf36d 60%, #fbf36d 100%); + background: -o-linear-gradient(top, transparent 0%, transparent 65%, #fbf36d 60%, #fbf36d 100%); + background: -ms-linear-gradient(top, transparent 0%, transparent 65%, #fbf36d 60%, #fbf36d 100%); + background: linear-gradient(to bottom, transparent 0%, transparent 65%, #fbf36d 60%, #fbf36d 100%); +} + +:target:hover { + background: -webkit-linear-gradient(top, transparent 0%, transparent 0%, #fbf36d 0%, #fbf36d 100%); + background: -moz-linear-gradient(top, transparent 0%, transparent 0%, #fbf36d 0%, #fbf36d 100%); + background: -o-linear-gradient(top, transparent 0%, transparent 0%, #fbf36d 0%, #fbf36d 100%); + background: -ms-linear-gradient(top, transparent 0%, transparent 0%, #fbf36d 0%, #fbf36d 100%); + background: linear-gradient(to bottom, transparent 0%, transparent 0%, #fbf36d 0%, #fbf36d 100%); +} + +/* @end */ + +/* @group Dropdown menus */ + +#preferences-menu, #style-menu { + width: 25em; + overflow-y: auto; +} + +/* @end */ diff --git a/Docs/haskell/meta.json b/Docs/haskell/meta.json new file mode 100644 index 0000000..4e0bb86 --- /dev/null +++ b/Docs/haskell/meta.json @@ -0,0 +1 @@ +{"haddock_version":"2.29.2"} \ No newline at end of file diff --git a/Docs/haskell/p2prc.haddock b/Docs/haskell/p2prc.haddock new file mode 100644 index 0000000000000000000000000000000000000000..af23673d7ed3ab9cfc543e39655cf8096876b8a0 GIT binary patch literal 5515 zcma)ATW{OQ6{bX)zR363&du3OoSVICX&tYVX453Cp}2__u_MGzi$2oiNMb~h>u zx(vDkx(d1mx(-?g-2iNMrpmEPxl`dOdbLlqv74j@EALZR5UV*fG|nDQ+lP5J3b9Whfrr zZga?e##!HuA};E7sl3=snICh>x-R-5J5IGy{%c7~%m&@S>yj9K?nWueaLU=h75MIH zoTV({1J(;7U$VHJuN}oH8}bw?^5QH?AvvT-X-i%h@F=abmrz)Cim%EH3)6OzEDWK* zU*SDPkKpW#iy<5E(2M(=mJRxeh#{fgUl)_YAnLHwp;8Jx_G3&Vtr=Nly zg%~btylxh{Q%7YRuGQnj9nj~noX2IZ(28NWHTq1%vM4{^bK1Ad0OANjOZg#b!M)fw zFtE$3jku4q@LA+yoBRX!GAL|J=vgHngQ}A(waNGPjgR0u0B&4=URJL zh^W`^V@qy_JEgK+vF>Se0O0?pIaDyXcz<*2^Dnk*^)GiG?0&WP@R6PdtN-*gvd`() zD-%Z6zgZ)t0h;{;k_w&(E&&Hu84}O~BVx@KbA2BJ>I@?&OJSIXBAyOn(W^V=vnyZ+ zP9$04UNLd<)8mhd@hLO@`;rk$a4#0HtFD`}9_I-RP?=aRn3utmzyKuVjxC=d`9(X65%t(yMj zqTeWN){HK`o)40!$Q=vX?6un}Yei(z^K)6YQohUb}k6PI;xrFx;AnNg9 zKG+ucFu^ViWJ>29Bn5yjLUPqCxAF^GgT(Q004Xq##$wHk|4~D3gnqybi%6|uOlb$5 zEJuWbqR-nnei#9{#S|Mog@eE&R0j>ZXF;5ak4F{<^-tK;5s z{WYC-Ve7fa$xlaK8|U0@#9`KtFa`v{$b9xHmMP+|F-Rq2i;PACbZzbOm6g>AXL4$~ zIx{;rzp%KpeCa9#B`=EXMg2aNlFSEF*UfhRq*Y%4gLIq+PW7+c3v}-ZPM!(@-IX$i zCsJL8cre#S$lX0tqXVr~)uWboMhLlR2}bLz^# zW9=+b>6se_=@5Z~@Z%z#fLh+i0i`ieS`klfnx$rsQ&>S^ji#S9VaiBMg^2 zSwTqaP#I>v&W2(6i*=BTtCXG}k5VO>L}+YArI)1OevFmJtmk&|wGvXee`^<4>>6nn zay9K(5M#+jNCt~nxq^;gn>>=4a+*j`Go(#gt%X}qOk3K?WI>4JE`#?YtMmhc5ky3m zc%wW6+atwzyk07;R4$b#4?egQ-R<(fAQMNJ!}+Rgit7O;yYYY#rIZjFk%3brmKmkW zI3<0Y>X-_d3RXH(1j#4W^0zkl)N<^}6XfIvDh=29lG+c@F*9O$hAekxhOstWBVr8v<1n$iT3=5dpHpN;nv zlNsBFc-(77LE2ERpBT^ge9TMe(%+Ri?^w^r%!h8G{EwD^KAiU$#@`f=TU)I5ywDL% zsMXjnVb(Zxq&Q*R2|T47C{T!>(`| z%I5&c^Eg+oqi~O~KjOf3DdAqwh8yW>kA5z>0XVgnEYehiRu~8uDQyTDKp5l^7vpB( z!sn1?ad$+di=&V{l!iTSZ0e#zF@q+-$kxjbneV2`_=;(P{7e81dyt$`MP~Z=l5G{{uE=)e z4Qo)5apZt|tFLzK@y_ENw(%amy6*N6E24T3Z)k3Ou5@QS#4Zws6n^vBbm#;MV!GFe zlc69}WSfmGw!5>tSEGh~gKx8+aS_3{a#_0m^5`9V*?PS_x+v_bd-*BulBJFF%+4sqt*nkmc?5lR z;rjo$aO^)qk-|nPrGi_URiT1Pg(@l)DycX&YAOyDRUE3SI5x^E4%Jm03xyTOLS@CV zP+D;;)K(k|#TCawb;YqzUU4kcR~!ok7RN$`#j#Ohaj3@P*eJ3%RAq52Mz6Q%6}C2M z-$nz~~wkq3iJpg*feast3_oAmXTx ztJ=f?RYGiB^()^Tzd5qu?45(CgKT>4T&!3;?14vL($$o;!=Cyt?$<3{2$(Ay!a+B>866we;^%u9v5TscT4^DEhupWnlrOkKNXq`CtT z-WN|%067HgLfoyW!;ai^g-g#(c$2~_ZBONMOP;y`(PH@(bABY&3BeVcJKs@N5lu%M z$VYGbrJB1rO7s^-R;zRQr7=6!J@X?DRkFb{=R2lGLD9s=>R3>mKOf~5=yfcRRmWmg zbu2tj6%J-m%C(L+xagn-$_*f literal 0 HcmV?d00001 diff --git a/Docs/haskell/quick-jump.css b/Docs/haskell/quick-jump.css new file mode 100644 index 0000000..cf10eee --- /dev/null +++ b/Docs/haskell/quick-jump.css @@ -0,0 +1,221 @@ +/* @group Fundamentals */ + +.hidden { + display: none; +} + +/* @end */ + +/* @group Search box layout */ + +#search { + position: fixed; + top: 3.2em; + bottom: 0; + left: calc(50% - 22em); + width: 44em; + z-index: 1000; + overflow-y: auto; +} + +@media only screen and (max-width: 999px) { + #search { + top: 5.7em; + } +} + +#search-form, #search-results { + box-shadow: 2px 2px 6px rgb(199, 204, 208); + pointer-events: all; +} + +#search-form input { + font-size: 1.25em; line-height: 2.3em; height: 2.4em; + display: block; + box-sizing: border-box; + width: 100%; + margin: 0; + padding: 0 0.75em; + border: 0.05em solid rgb(151, 179, 202); +} + +#search input:focus { + outline: none; +} + +#search p.error { + color: rgb(107, 24, 24); + font-weight: bold; +} + +#search-results { + box-sizing: border-box; + border: 0.05em solid #b2d5fb; + background: #e8f3ff; + max-height: 80%; + overflow: scroll; +} + +#search-form input + #search-results { + border-top: none; + top: 3em; + max-height: calc(100% - 3em); +} + +/* @end */ + +/* @group search results */ + +#search-results > ul { + margin: 0; + list-style: none; +} + +#search-results > ul > li, +#search-results > p, +#search-results > table { + padding: 0.5em 1em; + margin: 0; +} + +#search-results > ul > li { + border-bottom: 1px solid #b2d5fb; +} + +#search-results > ul > li > ul { + list-style: none; +} + +.search-module h4 { + margin: 0; +} + +.search-module > ul { + margin: 0.5em 0 0.5em 2em; +} + +.search-module > ul > li > a[href] { + display: block; + color: inherit; + padding: 0.25em 0.5em; +} + +.search-module > ul > li > a[href].active-link { + background: #faf9dc; +} + +.search-module a[href]:hover { + text-decoration: none; +} + +.search-result a a { + pointer-events: none; +} + +.search-result ul.subs { + display: inline-block; + margin: 0; padding: 0; +} + +.search-result ul.subs li { + display: none; +} + +.search-result ul.subs::after { + display: inline-block; + content: "..."; + color: rgb(78,98,114); + margin: 0 0.25em; +} + +.more-results { + color: rgb(99, 141, 173); + position: relative; +} + +.more-results::before { + content: "+"; + display: inline-block; + color: #b2d5fb; + font-weight: bold; + font-size: 1.25em; line-height: inherit; + position: absolute; + left: -1em; +} + +/* @end */ + +/* @group Keyboard shortcuts table */ + +.keyboard-shortcuts { + line-height: 1.6em; +} + +.keyboard-shortcuts th { + color: rgb(78,98,114); +} + +.keyboard-shortcuts td:first-child, +.keyboard-shortcuts th:first-child { + text-align: right; + padding-right: 0.6em; +} + +.key { + display: inline-block; + font-size: 0.9em; + min-width: 0.8em; line-height: 1.2em; + text-align: center; + background: #b2d5fb; + border: 1px solid #74a3d6; + padding: 0 0.2em; + margin: 0 0.1em; +} + +/* @end */ + +/* @group Dropdown menus */ + +/* Based on #search styling above. */ + +.dropdown-menu { + position: fixed; + /* Not robust to window size changes. */ + top: 3.2em; + right: 0; + /* To display on top of synopsis menu on right side. */ + z-index: 1000; + border: 0.05em solid #b2d5fb; + background: #e8f3ff; +} + +@media only screen and (max-width: 999px) { + .dropdown-menu { + top: 5.7em; + } +} + +.dropdown-menu * { + margin: 0.1em; +} + +.dropdown-menu button { + border: 1px #5E5184 solid; + border-radius: 3px; + background: #5E5184; + padding: 3px; + color: #f4f4f4; + min-width: 6em; +} + +.dropdown-menu button:hover { + color: #5E5184; + background: #f4f4f4; +} + +.dropdown-menu button:active { + color: #f4f4f4; + background: #5E5184; +} + +/* @end */ diff --git a/Docs/haskell/synopsis.png b/Docs/haskell/synopsis.png new file mode 100644 index 0000000000000000000000000000000000000000..85fb86ec84907bcc86531dc82871948ff4d471fa GIT binary patch literal 11327 zcmV-FEWp!=P)4Tx0C)k_S!GyNTeqHT_l8Y(cXyX`gGi?cY`Qxn1VID|MJXwjPC)?)F$h6K zMMOd+6hs7sqbPzXbr*U(-*=zy-hcPcUC*=TdiNM(jyd-lv&OpsU|J&v2m2!^0SE{T z54F(O;E2!K(!rTCW z%wV;vdzf1QjBf#e&~gh74F>?Z4a=WLg$KhJ^$5nap>PLbJadS>e&h8+?D`9%QNL`g zEVKbYGXj7k5Q(8)0Fd#*a?VIMFW3*64geVHKzE-&0BG!BtmfuTbO(T`0Jaeg2nagF z{V*1E{Wm{e|AvV~*MEExiC+KU-~R=!2{)|c6Bg`GjQ;iG|FQ`1kAUCTuZtQk34#8{ z4r4(3g7#|{=Z@d+d#}7f!3C=>=26vx*jwA8>@MS>RG@Tt_zt3hie^T z_?0%9VUd=)Fos7I z^ghPh%Jy%YZ|)vCf6EaFPai$Q-!=$ppK!y&wrJs)bNdAuANB!m3n34Tfj{s75g-&U z1A!Pg3bcXF-=!Gv1VmU93G2duANT;{0JugFTqg*|oPXPC|A$2HS3NJd-hcPV3EW`Y zh=1Dr-5Mv{<{zIvz#Ybay&^Vcn^E_`qRfl{{bzYkp)4~$~NAx_VB;E z{?P)PU)DbV{Qi#~0H0@T9czDj06@6MNq8OrpdAz(9qQxd9nPr<&s+~tPQySqaZyfb zNh!%g_5YjeaLxMN*$sv_p;d%b#U$Wpz0Geb0U>E+EOsEQ;I!&= zNC6q(BFFWohy&t- zL?CHM5mJM6p`(xmWDmJOUQi$u0mVUQpbRJ*DuT+OI;a`C4fR4p&?xj8nuk`Puh35f z55*JWF{C0=8)=GkKzbrWk@3iMWInPS*@Wyu4kE{pbI3L14-^JPgW^Pq!Q<2bWsPz} zg`nb5nW!REEvg;Wj~YYGqt;RTXfiY_S_G|(HbmQ@z0gtU6m&ki8r_B-Ku@3-(OVb{ zh8`n;QNS2r>@mKWSWG773g!l;2Q!LUz-(f%SSG9pRuyZCC1S&|DcC~nb!<2G1$Gg; zjU&Zz;G}VSI0sxHE(w>9tH<5Py}&KucJP#VKD;vC6z`6Y#%JLx@m=^4{33pbgo;Ff zM3uyf#Fr$Iq=2M}WPoIbWP_BHl$%tE)ST3Z^fYM!=}po{r1PXd2-E~&f;PdC5J9*= zs3G(aUK2LR$jJD~G{_vt!pSa>)sa0QdqcKOPD3tEZbLrbsZB|wjHfK7yiNI%a+8XNN{Y&qDu61Js-9|yYMB~K%}=dM z?M|IcT|xbTdVvN>!$YG@<3@9arjllWW|0;{D?n>V>r0zK+erJ2cAbuzPL|Gw?j&6? z-95TFdL%tRy&=6neHMKS{UrTQ1~vvw1`mcbh9-s=4Br`97&RC@7}FVVFitT3Wa4Df zW%6UX#MHqw%Zy?cW;SPzV!p~ez`Vvn%c8>K#*)s`!ZO8*U=?PyV2x$1V13HE$;Qs6 z&lb#9$o7D3jh&udgWZ=sm;FBb3I`2`8ix-@E=M=VM@~9UO-_H#0?vNUbuLye1Fi_J zGOlM_JKO@?*4#+T3Fgmx>$N#hD=6JCPAiC=8LR|tcUDX*;jHjawc-Aa(!}p@(S{y z@=fw93cLy~3MC3J6=@aC6f+ecDWR3LloFKgD*aHFR}NQhQU0tVrsAhkud;kZ;E2bO z$|DP^+^R&?GSxXXPBj;`QnfjCE_I@Mx%xW|9u0SmYKzbdmB(*}d+O)oF zD{G(9?$JT&=D|u+DJZ zNWtioQNJ<4*wVPj_}x+AqoGH;Ob{kUCOIZE$M}u~9_ug#riP|Drn6=OW+7&G%rWL> z=Ede8ETk;rECwxUES)XuEw`++tg@`8tp%+ktov*zY#eRsY`)v-*k;?#*-6-)vU_6B zZ0}>=>40^xaj16KJg$2@@A#sloMVdPRon; zro?jMrmLZAiR-$Xw%cX5Rd)^dT=x|ZRgY|sB~Mk)Y|mvcRj(Yc6>oL#eD5_MZJ#2a zFTMu8*L=VGnflfE9r)Y&-w413xCGn|qz?28>kOxb4~I`91S8Hy%txw47DsMJ*+jLTq&gXR@@ceibXxRMj9yGtEGpJ5wl9t= zE-`NYl;)|jcqraAzAu3%Avt03wEpSZM3O|m#Ni~#r0k?`XKc@OC9@@;PF^^xf3_io zJS8;cWvWW*wR5O*KIfjL$)pvg?Wen^KhBWM$j{i#bjy5vUg~_o`GX6d7oKIwXI;IB zxfpnH@{;j<`HmaI~Pakhkz+;ck(4 z(L}LU@r@GJlC+ZVSKP0>xT6f*a^OxsWU@9UjK2+LN4pu2v z)m1ZBXH@Ui1lG*eTGaN}Db&@~v({%dAQ~bXR<1ijt)TYR@l+GyI++oAU8_Vo_$j=4_z&e7XOxBI$Oy4voD->JFFb+`B) z-My^)B=?i=A9TlbZ}tTDto3^JF7!F~O+T=EFy3$8|7^f`;L$_9hYtod2fH7sKDs-k zJaqf9;^U4d@=w~I$~|oxmK$z+CjYE`L}8@!xzh8l(IcbxU#P$69n%?mIBq!pWa8Mw z=%n@JtCx;1=U%zLT7K>S`pZ=0)Xwzj8T3s0Eahze8`d}FZ-w68n3JEoH?K4Q^qu9q z=>@li)%RiVcNddCkbTHs;#jI%mR`QQqPOz=CgGy+9whdp4g`BLCvp!8U&;uov(!a2t+bEnRv6HXyi9t`-YglcEo`$K zI8GTZXYLH1F5YE+b^&9-c%dfYc~N>X1MygiCdpZ8N*OKLV7W5+5rusvVP$KTgd_E; zV`@J%*flk^Jhjj1)aX9cTQC5ItVZ(2W=FkE;*aH-)|+*kk6SET?pjmWaNEk+>D${o z_#cmV%sNr-bj$gX%QW$m8{|&wA?SI;%go!uC))SCU%7vKz~jI-L0?1Ap^RZ7;i?hG zB3+__P9{WW#uUa@#oavB8Q+`m==5;nXwvwZiR6j1<0+%5!{;8Q^`_s>XwIxTUvlAM z)|rdpmprp=bM$iM@_6#8@((Vr7Q8HcP;{fXs3iGH;8nY8TBRaov}JqcixtC_ZBw07?YBCLI#1vB=rX<|d6)j~ z?!9;SA9XkN4rDD83J6N{$`!z{xG&lW}=KCd6md=WHe zF)la3F!5t@`sLkMS6?Sg5vR3gcxTbGOK%>(y*_twKH{Cjg64anMViI^4{J-a%g0=3|@n*5+(H4=G;Z`Bm z0XDw2UUnY#t`5ZG&WObDFO_)C zCe0{aEki1k_dNXt+=U-mA1_W_8p^(%Qj|@Mb z9sM+h7-yIepVWIvd=>Y)XzKR#)XeT1jH zI8-@&65hs?W6g0$Tn9b?K9MevmJ{6JljSOT6GbGYHWfM5G<6M41g#z&E8Qx6H$yI? z50eHn6Z1ODBi1suSavH8F-{EUJXaTYHjh8AJ|73)7XPq7gt>OirQ5IDz)!g7S$y<#pnvPn` zTCcP(>sag3>W=B<=vx}l7>pa{8`&AN7|$LpGx0noeC)GnyV)so9SefRgyl6WA8Q%w zeVfO&`F8I1(hk7k+3~B6fhW|RD4pIpx4EPekGo2^q1>k2n?25Xx_BviQ+coYJoGK~ zi}SY&kPV~?{2VkK+z^r;>Jw%VE)ao-y@)AN%A4?QY z!X(X~xtpASHaNvFl_z!g+(cSqdP;^mD`$^mG5`i zpn$&+Rk%>pUtCp^dd2Um*){o6wlZ|t=klqF!OHfk>gs};%-W>7nEHr@(CeX%5lwM7 zQg7xp*S7SwzHLLbOLn+*Uc0?`NAB*$d)wWCJsW)~{h|X4gV%@BpPU*_8L1qd8t0!( zdySmVd!st{bK%K{=9Rj&=Ffv)KX1|hFxkC)82{hg(&3(fkq6-NB>?O?0kGBtAd?QJ zm0$~|LIBLj0I*U5i1iA9XzK$|?dCuG2lOlFq=GX}9v}f{nuc(O=>uZH1yBw;!3bD_ zU{(i`gLA_m=mOLPjX+-zbO8W#QsA+O&>1m7Uxak_`<>>nu%o*kx!T2DqomQ{`*59GHMHWa@qZ7S~^!Kl)z@vEz7SZjuAWovinywxMoS2FN7 zEH|1t%4A}H?2754xrD_j%Moi{n>gE7_6iP##}7_;J59Lg5Ifz(-D^B~y{dc!eQ)?H z1`GsQ2d{)Cgfm98MOmHv9&;s5@6?xs(nO0hxa6LcxN|CLdl`M_GqP+i31t7w9nHU9 zkY40hVt!S*RG^%pl2DDR1@+)Ms)_U_Lks^c#r9*J-d)LeEAIFAEIl9{kQ}rbihXiz zxOZfJbZ?wtQtXx5l+ld&8>=~scSi5kK8P(dtn9DO{nh=s_)Emb(M`^+uiKA)7VrA) zEB#tO5ODlSVZM$P@WWh#2Fx+Iz|6u~m`%6|24UXdCqxG`1g0=2kOkd@#-Q&AR(P%P zMdTpvAy(jBM;jT2tUyk{D~~EF3{{U>K(nFk;T(JdLx-`&6l3PF0@xsI7Y>87!d2q7 z@J9GD{0|aKlAELyq`{in5#@A}YP&ZEYQ#XH-V)Gsvv6_^~14ao?j4lj=6k7|w9iW!UZJhhvUlPHq(FxfQ) zq?V>>q`%8dxgeZ1aw#H*HTOZjUjc35y<*QR6jwV-iRB~}tyPXS=-S45n}+?ysv9OZ zzqJ(K(rR1j$hs}xHG4PtzG(M&@2Lj@{VyISJQ5#z^W@U7{hV|l=i6Vte3RLV-yYuK+dKCw{z!laG%#N$3ABJM%p<0O zYA^skKqQbP%m$r-WBwLFh0ujLomRwONMWQ8vL5*f<`CmhgJ?Rm2f718hVj63W7)9r z*mpQXTq~XnpG|@xNg&xFjU_!Gq>|CVvs#J#1w}9=HDxE2J2egUAWZ`85!yYvKKcv> zJ4PYKJ*G+KW|m8=VQlv7TJY|}%00wyKDli~41a=UN19Bb{{JVSQ=?d&3H&&qviwE*<+| zre!9^?4cDF}{Txa*#Kx+jZQvyZXwvVVG@WYFu7)G)>HwaCho zPBE;pGpDX4cqED@Z6)`nTsY^LE}F4-ek7|Lj+#LpTmF}Vfuf?4z^j_2v}GSEI;v7@ ztn0YySFg7=Mcq_r{?^*qM(m*I?Cd&z=li|$-7G!jeOwO;25=992SX5MzsmCeV$vtN*Wk9q%cvGzm6 zlGZYQ`Nc~9M~79`)tR-DzwAEIeH!_EZe4SI`^$~5?i-97Prt=)N^Q<3ePg@o zht*Hi&(|HuI*eO3a z*sFk(4fq>KkN@xQ6^F(cm~$_2K14li9;XkV|9<@!M&f%8Nam8p00009a7bBm000XU z000XU0RWnu7ytkil}SWFRCodHT?u#;Rkr@KbUNvfeG_5`YY-wNfPp{+o{ADgGcxep z5O;8ydCWk3pWowCbe1RjK4lzy;4&jKqk}U-a1=+ud7z@;LLwlFC>S)v1jwFrI_XY2 zop;WyuIf%_F~x?x|CCgE~7q5lBOq0>MKUdH^|7ARquk zTn+*P5DlHMG@8ELxbaVWHf?&T znHpfF&E_pZ&^rD;1;7qozi0Q$(`V)7{8<+kI>wdbHk%E>!9AN2eO+^{$KB)hHtVU6 z4;0@%KYw`%{kM%aj|)L>`1``u*EM%B_Ep|f_7iHT~t6&rZsneaT;XVt##n z3*O&%0=#!k4Gq$@x_XoAC663)d$?Wm=UXTrha?_sgD)BZa!4dhf)W5g$)o+5f!@!6p= z7>#E6lGpa0z~7?)*juclePn!mT$U>W2F?VqT7?}(LqHHhL#3+DoNXk5_#Pb{(lwSP zZ<=X|iSbjYeFoatR`H}3=!RdX3qeSTbc>FTPC&5WKoW3vT<}n4p!jve)Qtntp05&Y$`N~L&mauhNrjZlt#E%Rdnz*4RdA(~WsS0P~4Cker*^h9K3rID79 zAhx!)2_f*-6tD+E@|~5o_HbR*DQEm#fix64W;xPOIEsuwz3>ej`Mg}wlx+M?%^s;7 zt7<_1|D+24j|zb6{d*Duo)R*nQ%A&N`m}UK6}Gim#oV|jr-^I5{&3u6Y!z0&JjK=N zf~iA{0UNr_&1RH*=FkdaRxmwXu@ih1pW6b!KwO1@&&hNBf0 z=VYU~zns|bF>|Ig{pE8Oi&e4q8Sf>;d>$HnJ*g4^2E{@!BWJXj|MK2>t{)#4iCiKM z_X3_Wd3!22SVWGECF_5t9Wx1ebdVe1IRabo*K&Me+mp(08G`jsI~A7O*rz=A?*I(Ym_y4*ZBHj<`2EIL z@XCfeuGtW8G6RGFlFM<@CjE-OtU#5a;0kB%yXw(N%<3n(~sBeG(H{~)Y9EAyo%kT#Rg2j zpdOnacnjrpoDswQL%S&=xD)LJZ^c?^7~tUKxVSW2U-+UJ`I8c2{Q|sd4FLUcTr-0M zaqMa26wFKpz7U~s3AlNV^qhrHMbm9<`9gTLcVV_VCkYcW$bp+1aV?*4j`n;5NQvl5P$NHC1)DVqF ze?14Uta}S5dTDmrRR#Fn;tPAZ>c6M&cw`%zt17X5(`x+mXPZPMYENh$xHA{IIn#Q& z^ zG}YF_5*3HIuofIEDMeLB1jc8M#;C+D(d52>)gx`#@~i9ZqkAV_+e~x*&R~QFvHtHw zX=O8P?QIyJ9Ss9*B|&g;0hMp z3Alm-uHb+xn7Ts16&!E{`__2XkJh+p1UhOAxPk+&;D9SQ;0g}7f`^~4p*Mp`Hum_uHM8Ep9TllPO>m-^Cs zpVwg1bK6i`-w1z*2vDs7WXVaJJHyU=rk@Vk3#W^iKzdl}7D4^3u#E2B8*>%rGlt8u z5=Bg)^vMF>N2OW-kTeo=C=#;#Uwg6hiz=At%UPznGuZL$9uX3jIcgXzEoL+}ne7De zePX!NLIZ__1sfvpaY5fTR( zUH5HKQ7-^w@TCk-ATqS$+;^2Y-9Yg{p~En8>~LcE&~OCN2SO-y!qgT7qsff0kWR!$ z^D81!lBm$TfXL;}=Y9YJK+SF{!{d*=}ZDsk}pA}{0WdF3_)n|T5 zFNK7P(SF;zrP#jx9qieE2>F-K@p;gyHGt(@rI_!hEt)McpP}lbFn3v=a0JCAI=-Ld z^HfmLKw}#PgVO)j-n&3BpR3@}{)WrPilHHGIK3w22T8R6=u<`rMwjnBh~jFy5zt}A zN81hv!KkMXNNPDnh1mq7H@>uwma1@k3;2!wtQCOj+9tn%uigkWBw{AL|5)BofhX2& zA+XZ302%fCsUzg9CimQPVv`f;C6O8|{n>ML#6sZcPqU_9DPe!$!>g7coyleK6R!5=0O9Kit+4(r(6 ziv6QJ8-P(X4Sa3SakRGjFIv?a0G4_jZD3}d!^RD-cH>&cq5?d2jrKkeAp_;!Ur#;& z9W7Y4e9epUX=T6m-g%gom8l&2YDT>Vpn#D2K2TLOYC9;D1)wkDRn>N#8T3J_^Lk0W z2GEDo5^3Wxdgdfd9w7&WOIUcVywJ$#^9sz{H)rNATQUdN%*}+3f?}K#TL)6Cfb&`3 z%&Qjw3IaWJ_$1z;4dDsM&%YQ~=42pUgopbkSWmW!9lu+5e2Bl(Hp~!=)psw#l#5d7 z<59t4!9`Er%bRtn7l4p3WRMY9&31sf7Q0{HC$^-K>G(;07G_Pk5PmWfQbk{$>nD;C z$aX+;iw(co_@<~Qn^p+B=a%_MiWA>XQ&sn1{z<(6(1#*dufHEF>#Fe8m!&8!F2%dw zHlg}-8UFYJZG<8tdn)d^eHPNC3G-m$^7_440RBMV3*u1l6Q_-MckXuK!rmQ$k)#dR$sG z@^U71!@qOSF|2)@pOpG;Qm+AE#NKTmpy<6aRJ-8I$ex7UR10>zRSMI&Dx4*+aC%oe z$>ksZdHCl3@33X-u5M#~!F>8s>bP;(@Z1iZ5DQ57E(pe>^RmdH=2Rkv1Y;;r0f4a|kUQI?AO7tZbEf zJ(*E203jiWBR5FKRnt*$=_L9l06hS)bRb+XpPQ(|6)W>G1u?i-W6WoCJgUlRkTWYJ9y;~2lKhQP~5|72z2_#^8q&npdI^OKWZnM4)jd~lxFIKK%PKOm(9u+`!IG4P>PAtq9@Rh0JE!{0DuH! zkK`y|6ZXDM&ju*fYcM2?dkd?0BQd?AvKl9=rI$l^%Bzo%82pwp_ z3!t@d`N^j}MPee&>2}gr!FRvB)4o^~UCPYDMfxiI>b@c+MsVI_ZG?n%#SdILF9)yD z8iBv~&32h6$j=)^`5;_--)1F7aK==Pycf`JwRRcIa&EjD`NGhX@h9M+TM4YCmA;oJ zrO3=nv3MeD1n(z%`&dZj&7(JU#eehVv~0XE^yJ%^arZ3+;^s6cinJi_LRv*8MlRsh z{Xp^er2%-zvwii|iPQND<~cxwB;)S&_u$&{D%8_7aQMh%>8YP30yAe!z=De>;j*0J zN>6b7(K|VAAJyy)=J$-BZpMp7n5{I{+sN@1<}jm{UYm<6az zC)2KLBDKeY!To$ha&qG2BZqfAotPNM^BbQ^H8u4$*;5z(vZ|_v=c1LgH4&aJ8cR)s zhZ25=_;#ffO9d0sLd30K^&jiDoI6+3R|Htse-FYDw`bL=buUu;*yY6jR@v$9iMtOO z{Jm)a77X@ba%$f%7edh>l!!{woQDqvAyLn?wOiY*$B%zo zv32X~pEWczvH$rLZ56cfy6vr`0a$epDA9d}4E`PkfT>4BU?%e$j!CrfB%e1P1~}M{ zuQ8DZRRHLI>|J6XE5CNbPoY`u^Tv~L_DESt0J@K9biv&;RPgs@1TwMtC4bqg&n_U& z^RqpU@fmCZV8(Krcxd8Db|Y=v9v+%_sqO*ye5%7a4GH|cY5=AL^#T?U?(IAraOf}Z znfd(s?_l?Sx}{(;kM%5!ES&ry9?r8?uz9NYQ(Ynr1^j&q08@d8z|&jaWMSaE-1`Sx z2*lKk?$1KN8*2mJGw(g3`l+riN$dE3Q~;P7LCd=wx?7hW&8J3pu z_e%g|LIn2Oqk!C_wTCQ#s9zKa2tdEcq}@UR0njdQ`-LnZ0R1A9b_)drK)bx{7qWl= z^ovZ|Eff#{?eex?$N~b;FEVMjP(T2*%iDe-`+v|7m{y$1dn*6{002ovPDHLkV1lnB B5rhB$ literal 0 HcmV?d00001 diff --git a/haskell/gen_docs.sh b/haskell/gen_docs.sh new file mode 100755 index 0000000..d732d17 --- /dev/null +++ b/haskell/gen_docs.sh @@ -0,0 +1,9 @@ +#!/bin/bash + + +cabal haddock + + +rm -rf ../Docs/haskell + +cp -r ./dist-newstyle/build/x86_64-linux/ghc-9.6.5/p2prc-0.1.0.0/doc/html/p2prc/ ../Docs/haskell diff --git a/haskell/lib/API.hs b/haskell/lib/API.hs index f22e7b2..e949f11 100644 --- a/haskell/lib/API.hs +++ b/haskell/lib/API.hs @@ -15,7 +15,7 @@ import Error ) import JSON - ( IPAdressTable(..) + ( IPAddressTable(..) , MapPortResponse(..) , P2prcConfig ) @@ -33,12 +33,18 @@ import CLI import Environment ( cleanEnvironment ) -data P2PRCapi -- ^ Haskell API - = MkP2PRCapi -- ^ Main Constructor - { startServer :: IOEitherError ProcessHandle -- ^ start server +-- | Lower level P2PRC Haskell api that exposes basic functionality necessary to joint the network. + +data P2PRCapi + = MkP2PRCapi + { startServer :: IOEitherError ProcessHandle + -- ^ Start server , execInitConfig :: IOEitherError P2prcConfig - , execListServers :: IOEitherError IPAdressTable + -- ^ Instantiate server configuration + , execListServers :: IOEitherError IPAddressTable + -- ^ List servers in network , execMapPort :: MapPortRequest -> IOEitherError MapPortResponse + -- ^ Exposes and associates a local TCP port with a remote DNS address } @@ -52,7 +58,9 @@ data MapPortRequest = {-| This function cleans the previous running state (ensuring a pure P2PRC runtime state) and builds up a conditional 'P2PRCapi' instance. - __The following example show how this function can be used to expose the runtime functionalities:__ + ==== __Example__ + + The following example show how this function can be used to expose the runtime functionalities: @ example :: IOEitherError P2PRCapi diff --git a/haskell/lib/Engine.hs b/haskell/lib/Engine.hs index 773516b..15838df 100644 --- a/haskell/lib/Engine.hs +++ b/haskell/lib/Engine.hs @@ -45,7 +45,9 @@ import API {-| This function starts and bootstraps the P2PRC runtime that associates the a specific host's machine port to a DNS address to expose a certain application to the P2PRC network. You will only need to also import the 'MkMapPortRequest' data constructor to represent the this port request. - __This example demonstrates how it can be ran on the IO context:__ + ==== __Example__ + + This example demonstrates how it can be ran on the IO context: @ example :: IO () diff --git a/haskell/lib/JSON.hs b/haskell/lib/JSON.hs index 89549e7..9affc8c 100644 --- a/haskell/lib/JSON.hs +++ b/haskell/lib/JSON.hs @@ -2,7 +2,7 @@ module JSON ( P2prcConfig(..) - , IPAdressTable(..) + , IPAddressTable(..) , IPAddress(..) , ServerInfo(..) , MapPortResponse(..) @@ -17,7 +17,7 @@ import qualified Data.Text as T import Data.Aeson --- {-# WARNING MapPortResponse "This newtype is unstable at the moment due to the P2PRC's library error handling bug. For more information visit: https://github.com/Akilan1999/p2p-rendering-computation/issues/114#issuecomment-2474737015" #-} +{-# WARNING MapPortResponse "This newtype is unstable at the moment due to the P2PRC's library error handling bug. For more information visit: https://github.com/Akilan1999/p2p-rendering-computation/issues/114#issuecomment-2474737015" #-} -- ^ This represents P2PRC's response to the TCP port and DNS address allocation. This value will confirm the successful allocation and return information about it. newtype MapPortResponse @@ -39,31 +39,34 @@ instance FromJSON MapPortResponse where {-# WARNING P2prcConfig "This type is unstable at the moment due to the P2PRC's library error handling bug. For more information visit: https://github.com/Akilan1999/p2p-rendering-computation/issues/114#issuecomment-2474737015" #-} -newtype P2prcConfig -- ^ Host P2prc configuration - = MkP2prConfig -- ^ Unique Constructor + +-- | This represents the server configuration that defines its attributes and behaviours in the network, as well as, the location of the runtime persistence artifacts. +newtype P2prcConfig + = MkP2prConfig { machineName :: String -- ^ Machine Name - } - deriving Show + } deriving Show + + -- , hostServerPort :: Int + -- , iPV6Address :: Maybe String + -- , proxyPort :: Maybe Int + -- , fRPServerPort :: Bool + -- , behindNAT :: Bool + -- , iPTableKey :: String + -- , bareMetal :: Bool + -- , customConfig :: String + -- -- , iPTable :: String -- File -- , dockerContainers :: String -- Directory -- , defaultDockerFile :: String -- Directory -- , dockerRunLogs :: String -- Directory -- , speedTestFile :: String -- File - -- , iPV6Address :: Maybe String -- , pluginPath :: String -- Directory -- , trackContainersPath :: String -- File - -- , hostServerPort :: Int - -- , proxyPort :: Maybe Int - -- , groupTrackContainersPath :: File - -- , fRPServerPort :: Bool - -- , behindNAT :: Bool - -- , iPTableKey :: String -- , publicKeyFile :: String -- File -- , privateKeyFile :: String -- File -- , pemFile :: String -- File -- , keyFile :: String -- File - -- , bareMetal :: Bool - -- , customConfig + -- , groupTrackContainersPath :: String -- File -- TODO: p2prc API @@ -106,42 +109,44 @@ instance FromJSON P2prcConfig where parseJSON _ = mzero -{-# WARNING IPAdressTable "This newtype is highly unstable due to undergoing work on improving P2PRC's server api. For more information, visit: https://github.com/Akilan1999/p2p-rendering-computation/issues/114" #-} +{-# WARNING IPAddressTable "This newtype is highly unstable due to undergoing work on improving P2PRC's server api. For more information, visit: https://github.com/Akilan1999/p2p-rendering-computation/issues/114" #-} - --- | IP Table -newtype IPAdressTable - = MkIPAdressTable -- ^ Constructor - [ServerInfo] -- ^ List Servers +-- | This is a wrapper value that parses a json key value from the list of ip addresses in the network. +newtype IPAddressTable + = MkIPAddressTable -- ^ Wrapping constructor + [ServerInfo] -- ^ List current network servers deriving Show -instance FromJSON IPAdressTable where +instance FromJSON IPAddressTable where parseJSON = withObject "IPAdressTable" $ \ v -> - MkIPAdressTable <$> v .: "ip_address" + MkIPAddressTable <$> v .: "ip_address" {-# WARNING ServerInfo "This type is highly unstable due to undergoing work on improving P2PRC's server api. For more information, visit: https://github.com/Akilan1999/p2p-rendering-computation/issues/114" #-} +{- | + This is a record that keeps track of the current state of every node in the network. It is crucial information required for orchestration strategies. +-} data ServerInfo = MkServerInfo - { name :: T.Text - , ip :: IPAddress - , latency :: Int - , download :: Int - , upload :: Int - , serverPort :: Int - , bareMetalSSHPort :: Maybe Int - , nat :: Bool - , escapeImplementation :: Maybe T.Text - , customInformation :: Maybe T.Text + { name :: T.Text -- ^ Machine name + , ip :: IPAddress -- ^ Machine IP address + , latency :: Int -- ^ Response latency + , download :: Int -- ^ Download speed + , upload :: Int -- ^ Upload speed + , serverPort :: Int -- ^ Server port number + , bareMetalSSHPort :: Maybe Int -- ^ SSH machine port number + , nat :: Bool -- ^ Checking if node is behind a NAT + , escapeImplementation :: Maybe T.Text -- ^ Type of NAT trasversal technique + , customInformation :: Maybe T.Text -- ^ Custom String information } deriving Show - +-- | This is a simple representation of the IP address of nodes in the network. data IPAddress - = MkIPv4 String - | MkIPv6 String + = MkIPv4 String -- ^ IP version 4 address + | MkIPv6 String -- ^ IP version 6 address deriving Show diff --git a/haskell/lib/P2PRC.hs b/haskell/lib/P2PRC.hs index c4bac51..72e3f11 100644 --- a/haskell/lib/P2PRC.hs +++ b/haskell/lib/P2PRC.hs @@ -50,14 +50,14 @@ module P2PRC -- | This section gives an overview on the runtime and host machine interfaces. , P2PRCapi(..) , P2prcConfig(..) + , MapPortRequest(..) + , MapPortResponse(..) -- ** Primitive data types -- | These types represent the core data that is communicated between requests and the runtime. - , IPAdressTable(..) + , IPAddressTable(..) , ServerInfo(..) , IPAddress(..) - , MapPortRequest(..) - , MapPortResponse(..) , Error(..) -- ** Type Synonyms @@ -72,7 +72,7 @@ import Engine ) import JSON - ( IPAdressTable(..) + ( IPAddressTable(..) , ServerInfo(..) , IPAddress(..) , MapPortResponse(..)