Safe Haskell	Safe-Inferred
Language	Haskell2010

Sound.SC3.Common.Help

Contents

RTF
SC-DOC

Description

Functions to access to the SC3 RTF & HTML based help systems.

Synopsis

sc3_rtf_help_dir :: IO FilePath
sc3_rtf_find_file :: FilePath -> IO (Maybe FilePath)
sc3_rtf_find_file_err :: FilePath -> IO FilePath
sc3_rtf_to_scd :: FilePath -> FilePath -> IO ()
sc3_rtf_help_translate :: String -> IO FilePath
sc3_rtf_help_scd_open :: (String, [String]) -> String -> IO ()
sc3_rtf_help_scd_open_emacs :: String -> IO ()
sc3_scdoc_help_url :: String
sc3_scdoc_help_dir :: IO String
sc3_scdoc_help_class :: String -> String
sc3_scdoc_help_operator :: String -> FilePath
sc3_scdoc_help_method :: Char -> (String, String) -> FilePath
sc3_scdoc_help_class_method :: (String, String) -> FilePath
sc3_scdoc_help_instance_method :: (String, String) -> FilePath
sc3_scdoc_help_path :: String -> String
sc3_scdoc_help_open :: Bool -> String -> IO ()
sc3_scdoc_help_server_command_path :: String -> FilePath
sc3_scdoc_help_server_command_open :: Bool -> String -> IO ()

RTF

sc3_rtf_help_dir :: IO FilePath Source #

Directory containing SC3 RTF help files.

sc3_rtf_find_file :: FilePath -> IO (Maybe FilePath) Source #

Find (case-insensitively) indicated file at sc3_rtf_help_dir. Runs the command "find -name" (so UNIX only).

sc3_rtf_find_file "SinOsc.help.rtf"
sc3_rtf_find_file "lfsaw.help.rtf"
sc3_rtf_find_file "softClip.rtf"

sc3_rtf_find_file_err :: FilePath -> IO FilePath Source #

error variant.

sc3_rtf_to_scd :: FilePath -> FilePath -> IO () Source #

Run the command unrtf (so UNIX only) to convert an RTF file to a TEXT (.scd) file.

sc3_rtf_help_translate :: String -> IO FilePath Source #

sc3_rtf_to_scd of sc3_rtf_find_file_err, writing output to TMPDIR

sc3_rtf_help_scd_open :: (String, [String]) -> String -> IO () Source #

sc3_rtf_help_translate and run editor.

sc3_rtf_help_scd_open_emacs :: String -> IO () Source #

sc3_rtf_help_scd_open with emacsclient --no-wait.

sc3_rtf_help_scd_open_emacs "lfsaw"

SC-DOC

sc3_scdoc_help_url :: String Source #

URL for online SC-DOC SuperCollider documentation.

sc3_scdoc_help_dir :: IO String Source #

Read the environment variable SC3_SCDOC_HTML_HELP_DIR. The default value is ~/.local/share/SuperCollider/Help.

sc3_scdoc_help_class :: String -> String Source #

Path to indicated SC3 class help file.

sc3_scdoc_help_class "SinOsc" == "Classes/SinOsc.html"

sc3_scdoc_help_operator :: String -> FilePath Source #

Generate path to indicated SC3 operator help file.

sc3_scdoc_help_operator "+" == "Overviews/Operators.html#+"

sc3_scdoc_help_method :: Char -> (String, String) -> FilePath Source #

Generate path to indicated SC3 method help.

sc3_scdoc_help_method '*' ("C","m") == "Classes/C.html#*m"

sc3_scdoc_help_class_method :: (String, String) -> FilePath Source #

Generate path to indicated SC3 class method help.

sc3_scdoc_help_class_method ("C","m") == "Classes/C.html#*m"

sc3_scdoc_help_instance_method :: (String, String) -> FilePath Source #

Generate path to indicated SC3 instance method help.

sc3_scdoc_help_instance_method ("C","m") == "Classes/C.html#-m"

sc3_scdoc_help_path :: String -> String Source #

SC3 help path documenting x.

sc3_scdoc_help_path "Operator.distort" == "Overviews/Operators.html#.distort"
sc3_scdoc_help_path "Collection.*fill" == "Classes/Collection.html#*fill"
sc3_scdoc_help_path "Collection.inject" == "Classes/Collection.html#-inject"
sc3_scdoc_help_path "SinOsc" == "Classes/SinOsc.html"

sc3_scdoc_help_open :: Bool -> String -> IO () Source #

Open SC3 help path, either the local file or the online version. Use BROWSER or x-www-browser.

Base.get_env_default "BROWSER" "x-www-browser"

sc3_scdoc_help_open True (sc3_scdoc_help_path "SinOsc")
sc3_scdoc_help_open True (sc3_scdoc_help_path "Collection.*fill")
sc3_scdoc_help_open False (sc3_scdoc_help_path "Collection.inject")

sc3_scdoc_help_server_command_path :: String -> FilePath Source #

Generate path to indicated SC3 instance method help. Adds initial forward slash if not present.

let r = "Reference/Server-Command-Reference.html#/b_alloc"
sc3_scdoc_help_server_command_path "b_alloc" == r

sc3_scdoc_help_server_command_open :: Bool -> String -> IO () Source #

sc3_scdoc_help_open of sc3_server_command_path

sc3_scdoc_help_server_command_open True "s_new"
sc3_scdoc_help_server_command_open False "/b_allocRead"