Skip to content

cloogle.org
cloogle.org
Verified Commit 5d74f126 authored by Camil Staps's avatar Camil Staps 🐾
Browse files
Options

Update links for move to GitLab

parent 7958fe98
Hide whitespace changes
Inline Side-by-side
Showing with 53 additions and 55 deletions
.gitmodules
View file @ 5d74f126
[submodule "backend/Cloogle"]
path = backend/Cloogle
url = https://github.com/clean-cloogle/Cloogle
url = https://gitlab.science.ru.nl/cloogle/Cloogle
CONTRIBUTING.md
View file @ 5d74f126
......@@ -14,17 +14,17 @@ contributing to avoid wasting your or our time.
## 1. Bug reports
We use GitHub issues for bug tracking.
We use GitLab issues for bug tracking.
First, check if your bug has been reported already. If not, open a new GitHub
issue. Make sure to include the following:
First, check if your bug has been reported already. If not, open a new issue.
Make sure to include the following:
- Steps to reproduce
- Actual outcome
- Expected outcome
- How you're accessing Cloogle (through the frontend or directly to Clean)
**If you have found a security vulnerability**, please do **not** open a GitHub
**If you have found a security vulnerability**, please do **not** open an
issue. Instead, contact one of the maintainers (see the list in `README.md`).
We will take immediate action.
......@@ -35,12 +35,10 @@ We will take immediate action.
- [libcloogle][] describes the Cloogle API as a set of types. Because many
applications make assumptions about this API, one must be reluctant with
changing this. However, sometimes it is necessary. See
[`CONTRIBUTING.md`](https://github.com/clean-cloogle/libcloogle/blob/master/CONTRIBUTING.md)
[`CONTRIBUTING.md`](https://gitlab.science.ru.nl/cloogle/libcloogle/blob/master/CONTRIBUTING.md)
in that repository for more details.
- [Cloogle][] contains the core functionality for indexing and searching. It
relies on [CleanPrettyPrint][] to pretty-print the abstract syntax tree of
Clean, and on [CleanTypeUnifier][] to unify types in type search.
- This repository ([cloogle.org](https://github.com/clean-cloogle/cloogle.org))
- [Cloogle][] contains the core functionality for indexing and searching.
- This repository ([cloogle.org](https://gitlab.science.ru.nl/cloogle/cloogle-org))
is only a wrapper around [Cloogle][]. It contains functionality for TCP,
caching, the web frontend and statistics.
......@@ -111,7 +109,5 @@ queries so you can use `%` as in `%Linux%` - in most cases, the pattern will be
equal to the name. The optional `url` is a link to where the client may be used
or downloaded.
[Cloogle]: https://github.com/clean-cloogle/Cloogle
[libcloogle]: https://github.com/clean-cloogle/libcloogle
[CleanPrettyPrint]: https://github.com/clean-cloogle/CleanPrettyPrint
[CleanTypeUnifier]: https://github.com/clean-cloogle/CleanTypeUnifier
[Cloogle]: https://gitlab.science.ru.nl/cloogle/Cloogle
[libcloogle]: https://gitlab.science.ru.nl/cloogle/libcloogle
README.md
View file @ 5d74f126
......@@ -41,8 +41,8 @@ Old frontends:
## Auxiliary tools
Several tools used in Cloogle are available as separate libraries from
[github.com/clean-cloogle](https://github.com/clean-cloogle). Additionally,
these tools can be helpful:
[gitlab.science.ru.nl/cloogle](https://gitlab.science.ru.nl/cloogle).
Additionally, these tools can be helpful:
**[Cloogle-tags][cloogle-tags]:**
This program lets you index local Clean code in *tagfiles* that can be used by
......@@ -68,7 +68,7 @@ realtime usage chart is shown. For longterm statistics you can see
## Interfacing with Cloogle
**TCP API**
`CloogleServer` is a TCP server listening on port 31215 (typically). Send a
JSON request in the format described by the `Request` type in [Cloogle.dcl][],
JSON request in the format described by the `Request` type in [Cloogle.API][],
followed by a newline character. The response is in the format described by the
`Response` type. The connection is kept alive for some time to allow further
requests.
......@@ -92,7 +92,7 @@ The API returns the same JSON as the TCP API, but may include additional
results when searched for Clean error messages (for example, `stack overflow`).
These error messages are indexed by the frontend rather than the backend.
Additionally, the HTTP API may give return codes above 150, which are not used
by the TCP API. For the meaning of the return codes, see [Cloogle.icl][].
by the TCP API. For the meaning of the return codes, see [Cloogle.API (icl)][].
## Preparing a library for indexing
Your library will be most easily accessible when:
......@@ -162,20 +162,20 @@ Contributors:
- [SteffenMichels](https://github.com/SteffenMichels) (ABC documentation)
[cloogle.org]: https://cloogle.org
[Cloogle]: https://github.com/clean-cloogle/Cloogle
[libcloogle]: https://github.com/clean-cloogle/libcloogle
[Cloogle.dcl]: https://github.com/clean-cloogle/libcloogle/blob/master/Cloogle.dcl
[Cloogle.icl]: https://github.com/clean-cloogle/libcloogle/blob/master/Cloogle.icl
[CloogleBot]: https://github.com/clean-cloogle/CloogleBot
[Cloogle]: https://gitlab.science.ru.nl/cloogle/Cloogle
[libcloogle]: https://gitlab.science.ru.nl/cloogle/libcloogle
[Cloogle.API]: https://gitlab.science.ru.nl/cloogle/libcloogle/blob/master/Cloogle/API.dcl
[Cloogle.API (icl)]: https://gitlab.science.ru.nl/cloogle/libcloogle/blob/master/Cloogle/API.icl
[CloogleBot]: https://gitlab.science.ru.nl/cloogle/CloogleBot
[@CloogleBot]: https://telegram.me/CloogleBot
[cloogle-tags]: https://github.com/clean-cloogle/cloogle-tags
[cloogle-tags]: https://gitlab.science.ru.nl/cloogle/cloogle-tags
[cloogle-cli]: https://github.com/clean-cloogle/cloogle-cli
[cloogle-mail]: https://github.com/clean-cloogle/cloogle-mail
[cloogle-mail]: https://gitlab.science.ru.nl/cloogle/cloogle-mail
[clean-irc]: https://github.com/clean-cloogle/clean-irc
[cloogle.py]: https://github.com/clean-cloogle/cloogle.py
[cloogle.py]: https://gitlab.science.ru.nl/cloogle/cloogle-py
[Clean]: http://clean.cs.ru.nl
[vim-clean]: https://github.com/camilstaps/vim-clean
[vim-clean]: https://gitlab.science.ru.nl/cstaps/vim-clean
[docker-compose]: https://www.docker.com/products/docker-compose
[Hoogle]: https://github.com/ndmitchell/hoogle
......
Cloogle @ 354bfb15
Subproject commit a4a8a8809b83a4a66b3e8d3c9d6910515f3aa6f1
Subproject commit 354bfb150558d9837e6bd1dcd57210232c07067c
backend/CloogleServer.icl
View file @ 5d74f126
......@@ -107,6 +107,7 @@ where
unprepare (Uniq t) = Uniq (unprepare t)
unprepare (Forall ts t tc) = Forall (map unprepare ts) (unprepare t) (map unprepareTR tc)
unprepare (Arrow mt) = Arrow (unprepare <$> mt)
unprepare (Strict t) = Strict (unprepare t)
unprepareTR :: !TypeRestriction -> TypeRestriction
unprepareTR (Instance c ts) = Instance c (map unprepare ts)
......@@ -286,9 +287,9 @@ where
doInBackground :: (*a -> *a) *a -> *a
doInBackground f w
#! (pid,w) = fork w
| pid < 0 = abort "fork failed\n"
| pid > 0 = w // Parent: return directly
| pid == 0 = snd $ exit 0 $ f w // Child: do function
| pid < 0 = abort "fork failed\n"
| pid > 0 = w // Parent: return directly
| otherwise = snd $ exit 0 $ f w // Child: do function
test :: ![TestOption] !*File !*CloogleDB !*World -> *World
test opts queries db w
......@@ -375,6 +376,7 @@ where
, response_code = response.return
, results = length response.data
}
makeLogEntry _ _ = abort "CloogleServer: failure in makeLogEntry\n"
err :: CloogleError String -> Response
err c m = { return = toInt c
......
backend/Util/SimpleTCPServer.icl
View file @ 5d74f126
......@@ -29,7 +29,7 @@ where
= abort "fork failed\n"
| pid > 0 // Parent: handle new requests
= loop li w
| pid == 0 // Child: handle current request
| otherwise // Child: handle current request
#! (logst,w) = logger (Connected ip) Nothing w
= handle logst st dupChan w
......
frontend/Dockerfile
View file @ 5d74f126
......@@ -37,7 +37,7 @@ RUN bash iconv.sh
# Build common problems index
RUN apt-get update -qq && apt-get install -qq python3 ca-certificates git\
&& git clone https://github.com/clean-cloogle/common-problems /tmp/common-problems\
&& git clone https://gitlab.science.ru.nl/cloogle/common-problems /tmp/common-problems\
&& cd /tmp/common-problems\
&& ./build_index.py\
&& mv common-problems.json /var\
......
frontend/api.js
View file @ 5d74f126
......@@ -605,7 +605,7 @@ function getResults(str, libs, include_builtins, include_core, include_apps, pag
'<div class="result-extra">' +
meta.join('<br/>') +
'<br class="parbreak"/>' +
'<a href="https://github.com/clean-cloogle/cloogle.org/blob/master/backend/Builtin/Syntax.icl" target="_blank">Edit this explanation on GitHub.</a>' +
'<a href="https://gitlab.science.ru.nl/cloogle/cloogle-org/blob/master/backend/Builtin/Syntax.icl" target="_blank">Edit this explanation on GitLab.</a>' +
'</div>' +
'<div class="result-extra toggle-container">' +
toggler +
......@@ -622,7 +622,7 @@ function getResults(str, libs, include_builtins, include_core, include_apps, pag
': <code>' + extra['abc_instruction'] + '</code></div>' +
'<div class="result-extra">' +
meta.join('<br/>') +
'<a class="parbreak" href="https://github.com/clean-cloogle/cloogle.org/blob/master/backend/Builtin/ABC.icl" target="_blank">Edit this explanation on GitHub.</a>' +
'<a class="parbreak" href="https://gitlab.science.ru.nl/cloogle/cloogle-org/blob/master/backend/Builtin/ABC.icl" target="_blank">Edit this explanation on GitLab.</a>' +
'</div>' +
'<pre class="result-code">' +
highlightClean(line, null, line[0] == '.' ? 'abc' : 'abcInstruction') +
......@@ -645,8 +645,8 @@ function getResults(str, libs, include_builtins, include_core, include_apps, pag
result.problem_description.cloogleMarkup() +
'<br class="parbreak"/>Possible solutions:<ul>' + solutions + '</ul>' +
(examples != '' ? ('Examples:<ul>' + examples + '</ul>') : '') +
'<a href="https://github.com/clean-cloogle/common-problems/blob/master/' + result.problem_key + '.md" target="_blank">Edit this explanation on GitHub.</a>' +
'<span class="problem-license">This text is licensed under <a href="https://github.com/clean-cloogle/common-problems/blob/master/LICENSE" target="_blank">CC-BY-SA-4.0</a>.</span>' +
'<a href="https://gitlab.science.ru.nl/cloogle/common-problems/blob/master/' + result.problem_key + '.md" target="_blank">Edit this explanation on GitLab.</a>' +
'<span class="problem-license">This text is licensed under <a href="https://gitlab.science.ru.nl/cloogle/common-problems/blob/master/LICENSE" target="_blank">CC-BY-SA-4.0</a>.</span>' +
'</div>' +
'<div class="result-code"></div>';
return res;
......@@ -708,9 +708,9 @@ function getResults(str, libs, include_builtins, include_core, include_apps, pag
'<ul>' +
'<li>To search for function, type or class names, remove whitespace from your query.</li>' +
'<li>If you do not know the name of the function you\'re looking for, consider using unification search (e.g. <code>:: a [a] -> Bool</code>)</li>' +
'<li>If you cannot find an error message, it may not be indexed yet. See the index <a href="https://github.com/clean-cloogle/common-problems">on GitHub</a>, where you can also open an issue to have the error message added.</li>' +
'<li>If you cannot find an error message, it may not be indexed yet. See the index <a href="https://gitlab.science.ru.nl/cloogle/common-problems">on GitLab</a>, where you can also open an issue to have the error message added.</li>' +
'<li>Click on "How to use" above for query examples.</li>' +
'<li>Open an issue <a href="https://github.com/clean-cloogle/cloogle.org">on GitHub</a>.</li>' +
'<li>Open an issue <a href="https://gitlab.science.ru.nl/cloogle/cloogle-org">on GitLab</a>.</li>' +
'</ul>'
elem.appendChild(p);
} else if (responsedata['return'] == 153) {
......@@ -718,7 +718,7 @@ function getResults(str, libs, include_builtins, include_core, include_apps, pag
p.innerHTML = 'Chances are your request got cached. ' +
'Try again in a few seconds to get the cached result. ' +
'If the problem persists, please ' +
'<a href="https://github.com/clean-cloogle/cloogle.org/issues/new">open an issue</a> ' +
'<a href="https://gitlab.science.ru.nl/cloogle/cloogle-org/issues/new">open an issue</a> ' +
'on our bug tracker.';
elem.appendChild(p);
}
......
frontend/index.php
View file @ 5d74f126
<!DOCTYPE html>
<html lang="en">
<head>
<!-- clean-cloogle/cloogle.org {{{COMMIT}}} -->
<!-- cloogle/cloogle-org {{{COMMIT}}} -->
<title>Cloogle</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
......@@ -19,7 +19,7 @@
<?php include('banners.php'); ?>
<div id="header">
<div id="logo">
<a href="https://github.com/clean-cloogle/cloogle.org">
<a href="https://gitlab.science.ru.nl/cloogle/cloogle-org">
<img src="logo.png" alt="follow link for the sourcecode" />
</a>
</div>
......@@ -115,18 +115,18 @@
<td class='description'>The class definition of <code>Text</code></td>
</tr>
</table>
<p>Besides this web app, there are <a href="https://github.com/clean-cloogle/cloogle.org/#frontends">other frontends</a> available.</p>
<p>Besides this web app, there are <a href="https://gitlab.science.ru.nl/cloogle/cloogle-org/#frontends">other frontends</a> available.</p>
<p>You can also <a href="src">browse the index</a> and <a href="doc">read the documentation</a>.</p>
</div>
</div>
<div id="contributetext" class="tooltip">
<div>
<p>
Development takes place on <a href="https://github.com/clean-cloogle/cloogle.org">GitHub</a>.
Please read the <a href="https://github.com/clean-cloogle/cloogle.org/blob/master/CONTRIBUTING.md">contributing guidelines</a> first.
Development takes place on <a href="https://gitlab.science.ru.nl/cloogle/cloogle-org">GitLab</a>.
Please read the <a href="https://gitlab.science.ru.nl/cloogle/cloogle-org/blob/master/CONTRIBUTING.md">contributing guidelines</a> first.
</p>
<p>
For bug reports, open an issue in the <a href="https://github.com/clean-cloogle/cloogle.org/issues">issue tracker</a>.
For bug reports, open an issue in the <a href="https://gitlab.science.ru.nl/cloogle/cloogle-org/issues">issue tracker</a>.
</p>
</div>
</div>
......
frontend/src/src.php
View file @ 5d74f126
......@@ -17,7 +17,7 @@ if (!is_readable($fname)) {
echo '<p>There is no definition module. Tick "Show implementation" to see the implementation module.</p>';
} else {
echo '<p><code>' . $fname . '</code> does not exist.</p>';
echo '<p>If you believe this is an error, please report it <a href="https://github.com/clean-cloogle/cloogle.org/issues/new">on GitHub</a>.';
echo '<p>If you believe this is an error, please report it <a href="https://gitlab.science.ru.nl/cloogle/cloogle-org/issues/new">on GitLab</a>.';
}
exit();
}
......
frontend/stats/ajax/conf.php
View file @ 5d74f126
......@@ -48,10 +48,10 @@ $user_agents =
, 'Macintosh' => ['pattern' => '%Macintosh%']
, 'Windows' => ['pattern' => '%Windows%']
, 'CloogleBot' => ['pattern' => 'CloogleBot', 'url' => 'https://telegram.me/CloogleBot']
, 'vim-clean' => ['pattern' => 'vim-clean', 'url' => 'https://github.com/camilstaps/vim-clean']
, 'vim-clean' => ['pattern' => 'vim-clean', 'url' => 'https://gitlab.science.ru.nl/cstaps/vim-clean']
, 'cloogle-cli' => ['pattern' => 'cloogle-cli', 'url' => 'https://github.com/clean-cloogle/cloogle-cli']
, 'CloogleMail' => ['pattern' => 'CloogleMail', 'url' => 'mailto:query@cloogle.org']
, 'cloogle-irc' => ['pattern' => 'cloogle-irc', 'url' => 'https://github.com/clean-cloogle/clean-irc']
, 'CloogleDiscord' => ['pattern' => 'CloogleDiscord', 'url' => 'https://github.com/ErinvanderVeen/cloogle-discord']
, 'CloogleDiscord' => ['pattern' => 'CloogleDiscord', 'url' => 'https://github.com/clean-cloogle/cloogle-discord']
, 'clean-vscode' => ['pattern' => 'clean-vscode', 'url' => 'https://github.com/W95Psp/CleanForVSCode']
];
libs.json
View file @ 5d74f126
......@@ -29,8 +29,8 @@
},
{
"name": "StdEnv",
"fetch_url": ["Git", "https://github.com/clean-cloogle/StdEnv-doc"],
"info_url": "https://github.com/clean-cloogle/StdEnv-doc",
"fetch_url": ["Git", "https://gitlab.science.ru.nl/cloogle/StdEnv-doc"],
"info_url": "https://gitlab.science.ru.nl/cloogle/StdEnv-doc",
"pattern_exclude": [["PStartsWith","_startup"],["PStartsWith","_system"]]
},
{
......@@ -139,13 +139,13 @@
},
{
"name": "Cloogle",
"fetch_url": ["Git", "https://github.com/clean-cloogle/Cloogle"],
"info_url": "https://github.com/clean-cloogle/Cloogle"
"fetch_url": ["Git", "https://gitlab.science.ru.nl/cloogle/Cloogle"],
"info_url": "https://gitlab.science.ru.nl/cloogle/Cloogle"
},
{
"name": "libcloogle",
"fetch_url": ["Git", "https://github.com/clean-cloogle/libcloogle"],
"info_url": "https://github.com/clean-cloogle/libcloogle"
"fetch_url": ["Git", "https://gitlab.science.ru.nl/cloogle/libcloogle"],
"info_url": "https://gitlab.science.ru.nl/cloogle/libcloogle"
},
{
"name": "SoccerFun",
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment