Compare commits
11
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a98c41f461
|
||
|
|
9064d5bd34
|
||
|
|
de00c532c8
|
||
|
|
8892337b93
|
||
|
|
15b9f979a2 | ||
|
|
a146adfd16 | ||
|
|
4aed98ef04 | ||
|
|
7a89704c0b
|
||
|
|
d60ff3ee27
|
||
|
|
9ef37633cb
|
||
|
|
2ac2b4d2be
|
@@ -3,6 +3,74 @@
|
|||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||||
|
|
||||||
|
## 2022-05-23
|
||||||
|
|
||||||
|
### Changes
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Packages with breaking changes:
|
||||||
|
|
||||||
|
- There are no breaking changes in this release.
|
||||||
|
|
||||||
|
Packages with other changes:
|
||||||
|
|
||||||
|
- [`wyatt_http_client` - `v1.1.0`](#wyatt_http_client---v110)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### `wyatt_http_client` - `v1.1.0`
|
||||||
|
|
||||||
|
- **FEAT**: add oauth2 refresh token client.
|
||||||
|
|
||||||
|
|
||||||
|
## 2022-05-23
|
||||||
|
|
||||||
|
### Changes
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Packages with breaking changes:
|
||||||
|
|
||||||
|
- There are no breaking changes in this release.
|
||||||
|
|
||||||
|
Packages with other changes:
|
||||||
|
|
||||||
|
- [`wyatt_analysis` - `v2.1.0`](#wyatt_analysis---v210)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### `wyatt_analysis` - `v2.1.0`
|
||||||
|
|
||||||
|
- **FEAT**: add experimental rules in appropriate file.
|
||||||
|
|
||||||
|
|
||||||
|
## 2022-05-20
|
||||||
|
|
||||||
|
### Changes
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Packages with breaking changes:
|
||||||
|
|
||||||
|
- There are no breaking changes in this release.
|
||||||
|
|
||||||
|
Packages with other changes:
|
||||||
|
|
||||||
|
- [`wyatt_authentication_bloc` - `v0.2.1`](#wyatt_authentication_bloc---v021)
|
||||||
|
- [`wyatt_bloc_helper` - `v1.1.0`](#wyatt_bloc_helper---v110)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### `wyatt_authentication_bloc` - `v0.2.1`
|
||||||
|
|
||||||
|
- **FEAT**: add google, facebook, apple, twitter login.
|
||||||
|
|
||||||
|
#### `wyatt_bloc_helper` - `v1.1.0`
|
||||||
|
|
||||||
|
- **FEAT**: add provider, consumer and helpers.
|
||||||
|
|
||||||
|
|
||||||
## 2022-05-05
|
## 2022-05-05
|
||||||
|
|
||||||
### Changes
|
### Changes
|
||||||
|
|||||||
@@ -101,9 +101,19 @@ For example, if name is CRUD BLOC
|
|||||||
|
|
||||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||||
|
|
||||||
tl;dr : `type(scope): description` where type can be **feat, fix, docs, chores, ci, perf, refactor, style, test**, and scope is package name.
|
tl;dr : `type(scope): description`.
|
||||||
|
Here allowed <type> values:
|
||||||
|
|
||||||
examples:
|
- **feat** for a new feature for the user, not a new feature for build script. Such commit will trigger a release bumping a MINOR version.
|
||||||
|
- **fix** for a bug fix for the user, not a fix to a build script. Such commit will trigger a release bumping a PATCH version.
|
||||||
|
- **perf** for performance improvements. Such commit will trigger a release bumping a PATCH version.
|
||||||
|
- **docs** for changes to the documentation.
|
||||||
|
- **style** for formatting changes, missing semicolons, etc.
|
||||||
|
- **refactor** for refactoring production code, e.g. renaming a variable.
|
||||||
|
- **test** for adding missing tests, refactoring tests; no production code change.
|
||||||
|
- **build** for updating build configuration, development tools or other changes irrelevant to the user.
|
||||||
|
|
||||||
|
Some examples :
|
||||||
|
|
||||||
- `feat(auth): add AWS support.` = add a feature in authentication_bloc package.
|
- `feat(auth): add AWS support.` = add a feature in authentication_bloc package.
|
||||||
- `docs: update readme.` = update **this** readme file.
|
- `docs: update readme.` = update **this** readme file.
|
||||||
|
|||||||
@@ -1,3 +1,7 @@
|
|||||||
|
## 2.1.0
|
||||||
|
|
||||||
|
- **FEAT**: add experimental rules in appropriate file.
|
||||||
|
|
||||||
## 2.0.1
|
## 2.0.1
|
||||||
|
|
||||||
- **DOCS**: Update readme with new version.
|
- **DOCS**: Update readme with new version.
|
||||||
|
|||||||
@@ -0,0 +1,22 @@
|
|||||||
|
# Copyright (C) 2022 WYATT GROUP
|
||||||
|
# Please see the AUTHORS file for details.
|
||||||
|
#
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or
|
||||||
|
# any later version.
|
||||||
|
#
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU General Public License
|
||||||
|
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
include: package:wyatt_analysis/analysis_options.flutter.2.0.0.yaml
|
||||||
|
|
||||||
|
linter:
|
||||||
|
rules:
|
||||||
|
- use_super_parameters
|
||||||
|
- use_enums
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
name: wyatt_analysis
|
name: wyatt_analysis
|
||||||
description: Lint rules for Dart and Flutter used internally at Wyatt and Wyatt Studio.
|
description: Lint rules for Dart and Flutter used internally at Wyatt and Wyatt Studio.
|
||||||
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis
|
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis
|
||||||
version: 2.0.1
|
version: 2.1.0
|
||||||
|
|
||||||
environment:
|
environment:
|
||||||
sdk: '>=2.12.0 <3.0.0'
|
sdk: '>=2.12.0 <3.0.0'
|
||||||
@@ -1,3 +1,7 @@
|
|||||||
|
## 0.2.1
|
||||||
|
|
||||||
|
- **FEAT**: add google, facebook, apple, twitter login.
|
||||||
|
|
||||||
## 0.2.0+1
|
## 0.2.0+1
|
||||||
|
|
||||||
- Update a dependency to the latest release.
|
- Update a dependency to the latest release.
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
name: wyatt_authentication_bloc
|
name: wyatt_authentication_bloc
|
||||||
description: Authentication BLoC for Flutter
|
description: Authentication BLoC for Flutter
|
||||||
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_authentication_bloc
|
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_authentication_bloc
|
||||||
version: 0.2.0+1
|
version: 0.2.1
|
||||||
|
|
||||||
environment:
|
environment:
|
||||||
sdk: ">=2.15.1 <3.0.0"
|
sdk: ">=2.15.1 <3.0.0"
|
||||||
@@ -35,5 +35,5 @@ dev_dependencies:
|
|||||||
wyatt_analysis:
|
wyatt_analysis:
|
||||||
git:
|
git:
|
||||||
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||||
ref: wyatt_analysis-v2.0.1
|
ref: wyatt_analysis-v2.1.0
|
||||||
path: packages/wyatt_analysis
|
path: packages/wyatt_analysis
|
||||||
|
|||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# Files and directories created by pub.
|
||||||
|
.dart_tool/
|
||||||
|
.packages
|
||||||
|
|
||||||
|
# Conventional directory for build outputs.
|
||||||
|
build/
|
||||||
|
|
||||||
|
# Omit committing pubspec.lock for library packages; see
|
||||||
|
# https://dart.dev/guides/libraries/private-files#pubspeclock.
|
||||||
|
pubspec.lock
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (C) 2022 WYATT GROUP
|
||||||
|
* Please see the AUTHORS file for details.
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
|
* any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
{
|
||||||
|
"recommendations": [
|
||||||
|
"psioniq.psi-header",
|
||||||
|
"blaugold.melos-code"
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
{
|
||||||
|
"psi-header.changes-tracking": {
|
||||||
|
"isActive": true
|
||||||
|
},
|
||||||
|
"psi-header.config": {
|
||||||
|
"blankLinesAfter": 1,
|
||||||
|
"forceToTop": true
|
||||||
|
},
|
||||||
|
"psi-header.lang-config": [
|
||||||
|
{
|
||||||
|
"beforeHeader": [
|
||||||
|
"# -*- coding:utf-8 -*-",
|
||||||
|
"#!/usr/bin/env python3"
|
||||||
|
],
|
||||||
|
"begin": "###",
|
||||||
|
"end": "###",
|
||||||
|
"language": "python",
|
||||||
|
"prefix": "# "
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"beforeHeader": [
|
||||||
|
"#!/usr/bin/env sh",
|
||||||
|
""
|
||||||
|
],
|
||||||
|
"language": "shellscript",
|
||||||
|
"begin": "",
|
||||||
|
"end": "",
|
||||||
|
"prefix": "# "
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"begin": "",
|
||||||
|
"end": "",
|
||||||
|
"language": "dart",
|
||||||
|
"prefix": "// "
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"begin": "",
|
||||||
|
"end": "",
|
||||||
|
"language": "yaml",
|
||||||
|
"prefix": "# "
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"begin": "<!--",
|
||||||
|
"end": "-->",
|
||||||
|
"language": "markdown",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
"psi-header.templates": [
|
||||||
|
{
|
||||||
|
"language": "*",
|
||||||
|
"template": [
|
||||||
|
"Copyright (C) <<year>> WYATT GROUP",
|
||||||
|
"Please see the AUTHORS file for details.",
|
||||||
|
"",
|
||||||
|
"This program is free software: you can redistribute it and/or modify",
|
||||||
|
"it under the terms of the GNU General Public License as published by",
|
||||||
|
"the Free Software Foundation, either version 3 of the License, or",
|
||||||
|
"any later version.",
|
||||||
|
"",
|
||||||
|
"This program is distributed in the hope that it will be useful,",
|
||||||
|
"but WITHOUT ANY WARRANTY; without even the implied warranty of",
|
||||||
|
"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the",
|
||||||
|
"GNU General Public License for more details.",
|
||||||
|
"",
|
||||||
|
"You should have received a copy of the GNU General Public License",
|
||||||
|
"along with this program. If not, see <https://www.gnu.org/licenses/>."
|
||||||
|
],
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"dart.runPubGetOnPubspecChanges": false,
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
# Below is a list of people and organizations that have contributed
|
||||||
|
# to this project. Names should be added to the list like so:
|
||||||
|
#
|
||||||
|
# Name/Organization <email address>
|
||||||
|
|
||||||
|
Wyatt Group S.A.S
|
||||||
|
Malo Léon <malo.leon@wyattapp.io>
|
||||||
|
Hugo Pointcheval <git@pcl.ovh>
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
## 1.1.0
|
||||||
|
|
||||||
|
- **FEAT**: add provider, consumer and helpers.
|
||||||
|
|
||||||
|
## 1.0.0
|
||||||
|
|
||||||
|
- Initial version.
|
||||||
@@ -0,0 +1,685 @@
|
|||||||
|
/*
|
||||||
|
* Author: Hugo Pointcheval
|
||||||
|
* Email: git@pcl.ovh
|
||||||
|
* -----
|
||||||
|
* File: LICENSE
|
||||||
|
* Created Date: 20/05/2022 16:47:39
|
||||||
|
* Last Modified: 20/05/2022 16:47:39
|
||||||
|
* -----
|
||||||
|
* Copyright (c) 2022
|
||||||
|
*/
|
||||||
|
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
@@ -0,0 +1,161 @@
|
|||||||
|
<!--
|
||||||
|
* Copyright (C) 2022 WYATT GROUP
|
||||||
|
* Please see the AUTHORS file for details.
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
|
* any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Flutter - BloC Helper
|
||||||
|
|
||||||
|
<p align="left">
|
||||||
|
<a href="https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis">
|
||||||
|
<img src="https://img.shields.io/badge/Style-Wyatt%20Analysis-blue.svg?style=flat-square" alt="Style: Wyatt Analysis" />
|
||||||
|
</a>
|
||||||
|
<img src="https://img.shields.io/badge/SDK-Flutter-blue?style=flat-square" alt="SDK: Flutter" />
|
||||||
|
</p>
|
||||||
|
|
||||||
|
BloC Pattern utilities for Flutter.
|
||||||
|
|
||||||
|
## Using
|
||||||
|
|
||||||
|
### Mixin Helper
|
||||||
|
|
||||||
|
In any custom screen you can get quick access to bloc or repository by using the mixin helper.
|
||||||
|
|
||||||
|
```dart
|
||||||
|
add(context, CounterIncrement());
|
||||||
|
|
||||||
|
// or, if you want to use Cubit
|
||||||
|
|
||||||
|
bloc(context).increment();
|
||||||
|
```
|
||||||
|
|
||||||
|
> Note: in this context `bloc` returns a Cubit instance.
|
||||||
|
|
||||||
|
```dart
|
||||||
|
final repository = repo<CounterRepository>(context);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Only BlocProvider
|
||||||
|
|
||||||
|
If you want to use only `BlocProvider` you have to extends `BlocProviderScreen` or `CubitProviderScreen` depending on your use case.
|
||||||
|
|
||||||
|
```dart
|
||||||
|
class CounterPage extends BlocProviderScreen<CounterBloc, CounterEvent, CounterState> {
|
||||||
|
const CounterPage({super.key});
|
||||||
|
//...
|
||||||
|
}
|
||||||
|
|
||||||
|
// or, if you want to use Cubit
|
||||||
|
|
||||||
|
class CounterPage extends CubitProviderScreen<CounterCubit, CounterState> {
|
||||||
|
const CounterPage({super.key});
|
||||||
|
//...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Then, create a Bloc or Cubit instance by implementing the `create` method.
|
||||||
|
|
||||||
|
```dart
|
||||||
|
@override
|
||||||
|
CounterBloc create(BuildContext context) => CounterBloc();
|
||||||
|
|
||||||
|
// or, if you want to use Cubit
|
||||||
|
|
||||||
|
@override
|
||||||
|
CounterCubit create(BuildContext context) => CounterCubit();
|
||||||
|
```
|
||||||
|
|
||||||
|
Finaly, you have to implement the `buildChild` method to build your screen.
|
||||||
|
|
||||||
|
```dart
|
||||||
|
@override
|
||||||
|
Widget buildChild(BuildContext context) {
|
||||||
|
// return ...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
> Note: here, you can use BlocBuilder, BlocListener,... and access Bloc and Repository instance with the mixin helper.
|
||||||
|
|
||||||
|
### Only BlocConsumer
|
||||||
|
|
||||||
|
If you want to use only `BlocConsumer` you have to extends `BlocConsumerScreen` or `CubitConsumerScreen` depending on your use case.
|
||||||
|
|
||||||
|
> Note: using directly `BlocConsumer` assumes you have already provided a Bloc or Cubit instance.
|
||||||
|
|
||||||
|
```dart
|
||||||
|
class CounterPage extends BlocConsumerScreen<CounterBloc, CounterEvent, CounterState> {
|
||||||
|
const CounterPage({super.key});
|
||||||
|
}
|
||||||
|
|
||||||
|
// or, if you want to use Cubit
|
||||||
|
|
||||||
|
class CounterPage extends CubitConsumerScreen<CounterCubit, CounterState> {
|
||||||
|
const CounterPage({super.key});
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Then, just implement the `onBuild` method to build your screen.
|
||||||
|
|
||||||
|
```dart
|
||||||
|
@override
|
||||||
|
Widget onBuild(BuildContext context, CounterState state) {
|
||||||
|
return Text(state.count.toString());
|
||||||
|
// or... more complex widgets
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
> Note: you can override `onBuild`, but also `onListen`, `shouldBuildWhen` and `shouldListenWhen` methods.
|
||||||
|
|
||||||
|
### Both BlocProvider and BlocConsumer
|
||||||
|
|
||||||
|
You can use both `BlocProvider` and `BlocConsumer` in the same screen, with the `BlocScreen` or `CubitScreen` depending on your use case.
|
||||||
|
|
||||||
|
```dart
|
||||||
|
class CounterPage extends BlocScreen<CounterBloc, CounterEvent, CounterState> {
|
||||||
|
const CounterPage({super.key});
|
||||||
|
}
|
||||||
|
|
||||||
|
// or, if you want to use Cubit
|
||||||
|
|
||||||
|
class CounterPage extends CubitScreen<CounterCubit, CounterState> {
|
||||||
|
const CounterPage({super.key});
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Then, you can create a Bloc or Cubit instance by implementing the `create` method.
|
||||||
|
|
||||||
|
```dart
|
||||||
|
@override
|
||||||
|
CounterBloc create(BuildContext context) => CounterBloc();
|
||||||
|
|
||||||
|
// or, if you want to use Cubit
|
||||||
|
|
||||||
|
@override
|
||||||
|
CounterCubit create(BuildContext context) => CounterCubit();
|
||||||
|
```
|
||||||
|
|
||||||
|
And, finally, just implement the `onBuild` method to build your screen.
|
||||||
|
|
||||||
|
```dart
|
||||||
|
@override
|
||||||
|
Widget onBuild(BuildContext context, CounterState state) {
|
||||||
|
return Text(state.count.toString());
|
||||||
|
// or... more complex widgets
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
> Note: check **BlocProvider** and **BlocConsumer** documentation for more information.
|
||||||
|
|
||||||
|
You'll find a more examples in the `example/lib/counter/` directory.
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
include: package:wyatt_analysis/analysis_options.flutter.yaml
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
# Miscellaneous
|
||||||
|
*.class
|
||||||
|
*.log
|
||||||
|
*.pyc
|
||||||
|
*.swp
|
||||||
|
.DS_Store
|
||||||
|
.atom/
|
||||||
|
.buildlog/
|
||||||
|
.history
|
||||||
|
.svn/
|
||||||
|
migrate_working_dir/
|
||||||
|
|
||||||
|
# IntelliJ related
|
||||||
|
*.iml
|
||||||
|
*.ipr
|
||||||
|
*.iws
|
||||||
|
.idea/
|
||||||
|
|
||||||
|
# The .vscode folder contains launch configuration and tasks you configure in
|
||||||
|
# VS Code which you may wish to be included in version control, so this line
|
||||||
|
# is commented out by default.
|
||||||
|
#.vscode/
|
||||||
|
|
||||||
|
# Flutter/Dart/Pub related
|
||||||
|
**/doc/api/
|
||||||
|
**/ios/Flutter/.last_build_id
|
||||||
|
.dart_tool/
|
||||||
|
.flutter-plugins
|
||||||
|
.flutter-plugins-dependencies
|
||||||
|
.packages
|
||||||
|
.pub-cache/
|
||||||
|
.pub/
|
||||||
|
/build/
|
||||||
|
|
||||||
|
# Web related
|
||||||
|
lib/generated_plugin_registrant.dart
|
||||||
|
|
||||||
|
# Symbolication related
|
||||||
|
app.*.symbols
|
||||||
|
|
||||||
|
# Obfuscation related
|
||||||
|
app.*.map.json
|
||||||
|
|
||||||
|
# Android Studio will place build artifacts here
|
||||||
|
/android/app/debug
|
||||||
|
/android/app/profile
|
||||||
|
/android/app/release
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
# This file tracks properties of this Flutter project.
|
||||||
|
# Used by Flutter tool to assess capabilities and perform upgrades etc.
|
||||||
|
#
|
||||||
|
# This file should be version controlled.
|
||||||
|
|
||||||
|
version:
|
||||||
|
revision: ee4e09cce01d6f2d7f4baebd247fde02e5008851
|
||||||
|
channel: stable
|
||||||
|
|
||||||
|
project_type: app
|
||||||
|
|
||||||
|
# Tracks metadata for the flutter migrate command
|
||||||
|
migration:
|
||||||
|
platforms:
|
||||||
|
- platform: root
|
||||||
|
create_revision: ee4e09cce01d6f2d7f4baebd247fde02e5008851
|
||||||
|
base_revision: ee4e09cce01d6f2d7f4baebd247fde02e5008851
|
||||||
|
- platform: android
|
||||||
|
create_revision: ee4e09cce01d6f2d7f4baebd247fde02e5008851
|
||||||
|
base_revision: ee4e09cce01d6f2d7f4baebd247fde02e5008851
|
||||||
|
|
||||||
|
# User provided section
|
||||||
|
|
||||||
|
# List of Local paths (relative to this file) that should be
|
||||||
|
# ignored by the migrate tool.
|
||||||
|
#
|
||||||
|
# Files that are not part of the templates will be ignored by default.
|
||||||
|
unmanaged_files:
|
||||||
|
- 'lib/main.dart'
|
||||||
|
- 'ios/Runner.xcodeproj/project.pbxproj'
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
# bloc_helper_example
|
||||||
|
|
||||||
|
A new Flutter project.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
This project is a starting point for a Flutter application.
|
||||||
|
|
||||||
|
A few resources to get you started if this is your first Flutter project:
|
||||||
|
|
||||||
|
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
|
||||||
|
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
|
||||||
|
|
||||||
|
For help getting started with Flutter development, view the
|
||||||
|
[online documentation](https://docs.flutter.dev/), which offers tutorials,
|
||||||
|
samples, guidance on mobile development, and a full API reference.
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
# This file configures the analyzer, which statically analyzes Dart code to
|
||||||
|
# check for errors, warnings, and lints.
|
||||||
|
#
|
||||||
|
# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
|
||||||
|
# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
|
||||||
|
# invoked from the command line by running `flutter analyze`.
|
||||||
|
|
||||||
|
# The following line activates a set of recommended lints for Flutter apps,
|
||||||
|
# packages, and plugins designed to encourage good coding practices.
|
||||||
|
include: package:flutter_lints/flutter.yaml
|
||||||
|
|
||||||
|
linter:
|
||||||
|
# The lint rules applied to this project can be customized in the
|
||||||
|
# section below to disable rules from the `package:flutter_lints/flutter.yaml`
|
||||||
|
# included above or to enable additional rules. A list of all available lints
|
||||||
|
# and their documentation is published at
|
||||||
|
# https://dart-lang.github.io/linter/lints/index.html.
|
||||||
|
#
|
||||||
|
# Instead of disabling a lint rule for the entire project in the
|
||||||
|
# section below, it can also be suppressed for a single line of code
|
||||||
|
# or a specific dart file by using the `// ignore: name_of_lint` and
|
||||||
|
# `// ignore_for_file: name_of_lint` syntax on the line or in the file
|
||||||
|
# producing the lint.
|
||||||
|
rules:
|
||||||
|
# avoid_print: false # Uncomment to disable the `avoid_print` rule
|
||||||
|
# prefer_single_quotes: true # Uncomment to enable the `prefer_single_quotes` rule
|
||||||
|
|
||||||
|
# Additional information about this file can be found at
|
||||||
|
# https://dart.dev/guides/language/analysis-options
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
gradle-wrapper.jar
|
||||||
|
/.gradle
|
||||||
|
/captures/
|
||||||
|
/gradlew
|
||||||
|
/gradlew.bat
|
||||||
|
/local.properties
|
||||||
|
GeneratedPluginRegistrant.java
|
||||||
|
|
||||||
|
# Remember to never publicly share your keystore.
|
||||||
|
# See https://flutter.dev/docs/deployment/android#reference-the-keystore-from-the-app
|
||||||
|
key.properties
|
||||||
|
**/*.keystore
|
||||||
|
**/*.jks
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
def localProperties = new Properties()
|
||||||
|
def localPropertiesFile = rootProject.file('local.properties')
|
||||||
|
if (localPropertiesFile.exists()) {
|
||||||
|
localPropertiesFile.withReader('UTF-8') { reader ->
|
||||||
|
localProperties.load(reader)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
def flutterRoot = localProperties.getProperty('flutter.sdk')
|
||||||
|
if (flutterRoot == null) {
|
||||||
|
throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file.")
|
||||||
|
}
|
||||||
|
|
||||||
|
def flutterVersionCode = localProperties.getProperty('flutter.versionCode')
|
||||||
|
if (flutterVersionCode == null) {
|
||||||
|
flutterVersionCode = '1'
|
||||||
|
}
|
||||||
|
|
||||||
|
def flutterVersionName = localProperties.getProperty('flutter.versionName')
|
||||||
|
if (flutterVersionName == null) {
|
||||||
|
flutterVersionName = '1.0'
|
||||||
|
}
|
||||||
|
|
||||||
|
apply plugin: 'com.android.application'
|
||||||
|
apply plugin: 'kotlin-android'
|
||||||
|
apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle"
|
||||||
|
|
||||||
|
android {
|
||||||
|
compileSdkVersion flutter.compileSdkVersion
|
||||||
|
ndkVersion flutter.ndkVersion
|
||||||
|
|
||||||
|
compileOptions {
|
||||||
|
sourceCompatibility JavaVersion.VERSION_1_8
|
||||||
|
targetCompatibility JavaVersion.VERSION_1_8
|
||||||
|
}
|
||||||
|
|
||||||
|
kotlinOptions {
|
||||||
|
jvmTarget = '1.8'
|
||||||
|
}
|
||||||
|
|
||||||
|
sourceSets {
|
||||||
|
main.java.srcDirs += 'src/main/kotlin'
|
||||||
|
}
|
||||||
|
|
||||||
|
defaultConfig {
|
||||||
|
// TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
|
||||||
|
applicationId "com.example.bloc_helper_example"
|
||||||
|
// You can update the following values to match your application needs.
|
||||||
|
// For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-build-configuration.
|
||||||
|
minSdkVersion flutter.minSdkVersion
|
||||||
|
targetSdkVersion flutter.targetSdkVersion
|
||||||
|
versionCode flutterVersionCode.toInteger()
|
||||||
|
versionName flutterVersionName
|
||||||
|
}
|
||||||
|
|
||||||
|
buildTypes {
|
||||||
|
release {
|
||||||
|
// TODO: Add your own signing config for the release build.
|
||||||
|
// Signing with the debug keys for now, so `flutter run --release` works.
|
||||||
|
signingConfig signingConfigs.debug
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
flutter {
|
||||||
|
source '../..'
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
|
||||||
|
package="com.example.bloc_helper_example">
|
||||||
|
<!-- The INTERNET permission is required for development. Specifically,
|
||||||
|
the Flutter tool needs it to communicate with the running application
|
||||||
|
to allow setting breakpoints, to provide hot reload, etc.
|
||||||
|
-->
|
||||||
|
<uses-permission android:name="android.permission.INTERNET"/>
|
||||||
|
</manifest>
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
|
||||||
|
package="com.example.bloc_helper_example">
|
||||||
|
<application
|
||||||
|
android:label="bloc_helper_example"
|
||||||
|
android:name="${applicationName}"
|
||||||
|
android:icon="@mipmap/ic_launcher">
|
||||||
|
<activity
|
||||||
|
android:name=".MainActivity"
|
||||||
|
android:exported="true"
|
||||||
|
android:launchMode="singleTop"
|
||||||
|
android:theme="@style/LaunchTheme"
|
||||||
|
android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
|
||||||
|
android:hardwareAccelerated="true"
|
||||||
|
android:windowSoftInputMode="adjustResize">
|
||||||
|
<!-- Specifies an Android theme to apply to this Activity as soon as
|
||||||
|
the Android process has started. This theme is visible to the user
|
||||||
|
while the Flutter UI initializes. After that, this theme continues
|
||||||
|
to determine the Window background behind the Flutter UI. -->
|
||||||
|
<meta-data
|
||||||
|
android:name="io.flutter.embedding.android.NormalTheme"
|
||||||
|
android:resource="@style/NormalTheme"
|
||||||
|
/>
|
||||||
|
<intent-filter>
|
||||||
|
<action android:name="android.intent.action.MAIN"/>
|
||||||
|
<category android:name="android.intent.category.LAUNCHER"/>
|
||||||
|
</intent-filter>
|
||||||
|
</activity>
|
||||||
|
<!-- Don't delete the meta-data below.
|
||||||
|
This is used by the Flutter tool to generate GeneratedPluginRegistrant.java -->
|
||||||
|
<meta-data
|
||||||
|
android:name="flutterEmbedding"
|
||||||
|
android:value="2" />
|
||||||
|
</application>
|
||||||
|
</manifest>
|
||||||
+6
@@ -0,0 +1,6 @@
|
|||||||
|
package com.example.bloc_helper_example
|
||||||
|
|
||||||
|
import io.flutter.embedding.android.FlutterActivity
|
||||||
|
|
||||||
|
class MainActivity: FlutterActivity() {
|
||||||
|
}
|
||||||
+12
@@ -0,0 +1,12 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<!-- Modify this file to customize your launch splash screen -->
|
||||||
|
<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
|
||||||
|
<item android:drawable="?android:colorBackground" />
|
||||||
|
|
||||||
|
<!-- You can insert your own image assets here -->
|
||||||
|
<!-- <item>
|
||||||
|
<bitmap
|
||||||
|
android:gravity="center"
|
||||||
|
android:src="@mipmap/launch_image" />
|
||||||
|
</item> -->
|
||||||
|
</layer-list>
|
||||||
+12
@@ -0,0 +1,12 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<!-- Modify this file to customize your launch splash screen -->
|
||||||
|
<layer-list xmlns:android="http://schemas.android.com/apk/res/android">
|
||||||
|
<item android:drawable="@android:color/white" />
|
||||||
|
|
||||||
|
<!-- You can insert your own image assets here -->
|
||||||
|
<!-- <item>
|
||||||
|
<bitmap
|
||||||
|
android:gravity="center"
|
||||||
|
android:src="@mipmap/launch_image" />
|
||||||
|
</item> -->
|
||||||
|
</layer-list>
|
||||||
BIN
Binary file not shown.
|
After Width: | Height: | Size: 544 B |
BIN
Binary file not shown.
|
After Width: | Height: | Size: 442 B |
BIN
Binary file not shown.
|
After Width: | Height: | Size: 721 B |
BIN
Binary file not shown.
|
After Width: | Height: | Size: 1.0 KiB |
BIN
Binary file not shown.
|
After Width: | Height: | Size: 1.4 KiB |
@@ -0,0 +1,18 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<resources>
|
||||||
|
<!-- Theme applied to the Android Window while the process is starting when the OS's Dark Mode setting is on -->
|
||||||
|
<style name="LaunchTheme" parent="@android:style/Theme.Black.NoTitleBar">
|
||||||
|
<!-- Show a splash screen on the activity. Automatically removed when
|
||||||
|
the Flutter engine draws its first frame -->
|
||||||
|
<item name="android:windowBackground">@drawable/launch_background</item>
|
||||||
|
</style>
|
||||||
|
<!-- Theme applied to the Android Window as soon as the process has started.
|
||||||
|
This theme determines the color of the Android Window while your
|
||||||
|
Flutter UI initializes, as well as behind your Flutter UI while its
|
||||||
|
running.
|
||||||
|
|
||||||
|
This Theme is only used starting with V2 of Flutter's Android embedding. -->
|
||||||
|
<style name="NormalTheme" parent="@android:style/Theme.Black.NoTitleBar">
|
||||||
|
<item name="android:windowBackground">?android:colorBackground</item>
|
||||||
|
</style>
|
||||||
|
</resources>
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
|
<resources>
|
||||||
|
<!-- Theme applied to the Android Window while the process is starting when the OS's Dark Mode setting is off -->
|
||||||
|
<style name="LaunchTheme" parent="@android:style/Theme.Light.NoTitleBar">
|
||||||
|
<!-- Show a splash screen on the activity. Automatically removed when
|
||||||
|
the Flutter engine draws its first frame -->
|
||||||
|
<item name="android:windowBackground">@drawable/launch_background</item>
|
||||||
|
</style>
|
||||||
|
<!-- Theme applied to the Android Window as soon as the process has started.
|
||||||
|
This theme determines the color of the Android Window while your
|
||||||
|
Flutter UI initializes, as well as behind your Flutter UI while its
|
||||||
|
running.
|
||||||
|
|
||||||
|
This Theme is only used starting with V2 of Flutter's Android embedding. -->
|
||||||
|
<style name="NormalTheme" parent="@android:style/Theme.Light.NoTitleBar">
|
||||||
|
<item name="android:windowBackground">?android:colorBackground</item>
|
||||||
|
</style>
|
||||||
|
</resources>
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
|
||||||
|
package="com.example.bloc_helper_example">
|
||||||
|
<!-- The INTERNET permission is required for development. Specifically,
|
||||||
|
the Flutter tool needs it to communicate with the running application
|
||||||
|
to allow setting breakpoints, to provide hot reload, etc.
|
||||||
|
-->
|
||||||
|
<uses-permission android:name="android.permission.INTERNET"/>
|
||||||
|
</manifest>
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
buildscript {
|
||||||
|
ext.kotlin_version = '1.6.10'
|
||||||
|
repositories {
|
||||||
|
google()
|
||||||
|
mavenCentral()
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
classpath 'com.android.tools.build:gradle:7.1.2'
|
||||||
|
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
allprojects {
|
||||||
|
repositories {
|
||||||
|
google()
|
||||||
|
mavenCentral()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
rootProject.buildDir = '../build'
|
||||||
|
subprojects {
|
||||||
|
project.buildDir = "${rootProject.buildDir}/${project.name}"
|
||||||
|
}
|
||||||
|
subprojects {
|
||||||
|
project.evaluationDependsOn(':app')
|
||||||
|
}
|
||||||
|
|
||||||
|
task clean(type: Delete) {
|
||||||
|
delete rootProject.buildDir
|
||||||
|
}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
org.gradle.jvmargs=-Xmx1536M
|
||||||
|
android.useAndroidX=true
|
||||||
|
android.enableJetifier=true
|
||||||
+6
@@ -0,0 +1,6 @@
|
|||||||
|
#Fri Jun 23 08:50:38 CEST 2017
|
||||||
|
distributionBase=GRADLE_USER_HOME
|
||||||
|
distributionPath=wrapper/dists
|
||||||
|
zipStoreBase=GRADLE_USER_HOME
|
||||||
|
zipStorePath=wrapper/dists
|
||||||
|
distributionUrl=https\://services.gradle.org/distributions/gradle-7.4-all.zip
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
include ':app'
|
||||||
|
|
||||||
|
def localPropertiesFile = new File(rootProject.projectDir, "local.properties")
|
||||||
|
def properties = new Properties()
|
||||||
|
|
||||||
|
assert localPropertiesFile.exists()
|
||||||
|
localPropertiesFile.withReader("UTF-8") { reader -> properties.load(reader) }
|
||||||
|
|
||||||
|
def flutterSdkPath = properties.getProperty("flutter.sdk")
|
||||||
|
assert flutterSdkPath != null, "flutter.sdk not set in local.properties"
|
||||||
|
apply from: "$flutterSdkPath/packages/flutter_tools/gradle/app_plugin_loader.gradle"
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:equatable/equatable.dart';
|
||||||
|
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||||
|
|
||||||
|
part 'counter_event.dart';
|
||||||
|
part 'counter_state.dart';
|
||||||
|
|
||||||
|
class CounterBloc extends Bloc<CounterEvent, CounterState> {
|
||||||
|
CounterBloc() : super(const CounterInitial()) {
|
||||||
|
|
||||||
|
on<CounterIncrement>((event, emit) {
|
||||||
|
emit(CounterModified(state.count + 1));
|
||||||
|
});
|
||||||
|
|
||||||
|
on<CounterDecrement>((event, emit) {
|
||||||
|
emit(CounterModified(state.count - 1));
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
part of 'counter_bloc.dart';
|
||||||
|
|
||||||
|
abstract class CounterEvent extends Equatable {
|
||||||
|
const CounterEvent();
|
||||||
|
|
||||||
|
@override
|
||||||
|
List<Object> get props => [];
|
||||||
|
}
|
||||||
|
|
||||||
|
class CounterIncrement extends CounterEvent {}
|
||||||
|
|
||||||
|
class CounterDecrement extends CounterEvent {}
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
part of 'counter_bloc.dart';
|
||||||
|
|
||||||
|
abstract class CounterState extends Equatable {
|
||||||
|
final int count;
|
||||||
|
|
||||||
|
const CounterState(this.count);
|
||||||
|
|
||||||
|
@override
|
||||||
|
List<Object> get props => [count];
|
||||||
|
}
|
||||||
|
|
||||||
|
class CounterInitial extends CounterState {
|
||||||
|
const CounterInitial() : super(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
class CounterModified extends CounterState {
|
||||||
|
const CounterModified(super.count);
|
||||||
|
}
|
||||||
|
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:bloc_helper_example/counter/bloc/counter_bloc.dart';
|
||||||
|
import 'package:flutter/material.dart';
|
||||||
|
import 'package:wyatt_bloc_helper/wyatt_bloc_helper.dart';
|
||||||
|
|
||||||
|
class CounterBlocPage
|
||||||
|
extends BlocScreen<CounterBloc, CounterEvent, CounterState> {
|
||||||
|
const CounterBlocPage({super.key});
|
||||||
|
|
||||||
|
@override
|
||||||
|
CounterBloc create(BuildContext context) => CounterBloc();
|
||||||
|
|
||||||
|
@override
|
||||||
|
Widget onBuild(BuildContext context, CounterState state) {
|
||||||
|
final textTheme = Theme.of(context).textTheme;
|
||||||
|
return Scaffold(
|
||||||
|
appBar: AppBar(title: const Text('Counter with Bloc')),
|
||||||
|
body: Center(child: Text('${state.count}', style: textTheme.headline2)),
|
||||||
|
floatingActionButton: Column(
|
||||||
|
mainAxisAlignment: MainAxisAlignment.end,
|
||||||
|
crossAxisAlignment: CrossAxisAlignment.end,
|
||||||
|
children: <Widget>[
|
||||||
|
FloatingActionButton(
|
||||||
|
heroTag: null,
|
||||||
|
key: const Key('counterBlocView_increment_floatingActionButton'),
|
||||||
|
child: const Icon(Icons.add),
|
||||||
|
onPressed: () => add(context, CounterIncrement()),
|
||||||
|
),
|
||||||
|
const SizedBox(height: 8),
|
||||||
|
FloatingActionButton(
|
||||||
|
heroTag: null,
|
||||||
|
key: const Key('counterBlocView_decrement_floatingActionButton'),
|
||||||
|
child: const Icon(Icons.remove),
|
||||||
|
onPressed: () => add(context, CounterDecrement()),
|
||||||
|
),
|
||||||
|
],
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:bloc_helper_example/counter/cubit/counter_cubit.dart';
|
||||||
|
import 'package:flutter/material.dart';
|
||||||
|
import 'package:wyatt_bloc_helper/wyatt_bloc_helper.dart';
|
||||||
|
|
||||||
|
/// Important, this page assumes that the [CounterCubit] is provided.
|
||||||
|
class CounterConsumerPage
|
||||||
|
extends CubitConsumerScreen<CounterCubit, CounterState> {
|
||||||
|
const CounterConsumerPage({super.key});
|
||||||
|
|
||||||
|
@override
|
||||||
|
Widget onBuild(BuildContext context, CounterState state) {
|
||||||
|
final textTheme = Theme.of(context).textTheme;
|
||||||
|
return Scaffold(
|
||||||
|
appBar: AppBar(title: const Text('Counter with Consumer')),
|
||||||
|
body: Center(child: Text('${state.count}', style: textTheme.headline2)),
|
||||||
|
floatingActionButton: Column(
|
||||||
|
mainAxisAlignment: MainAxisAlignment.end,
|
||||||
|
crossAxisAlignment: CrossAxisAlignment.end,
|
||||||
|
children: <Widget>[
|
||||||
|
FloatingActionButton(
|
||||||
|
heroTag: null,
|
||||||
|
key: const Key('counterConsumerView_increment_floatingActionButton'),
|
||||||
|
child: const Icon(Icons.add),
|
||||||
|
onPressed: () => bloc(context).increment(),
|
||||||
|
),
|
||||||
|
const SizedBox(height: 8),
|
||||||
|
FloatingActionButton(
|
||||||
|
heroTag: null,
|
||||||
|
key: const Key('counterConsumerView_decrement_floatingActionButton'),
|
||||||
|
child: const Icon(Icons.remove),
|
||||||
|
onPressed: () => bloc(context).decrement(),
|
||||||
|
),
|
||||||
|
],
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:bloc_helper_example/counter/cubit/counter_cubit.dart';
|
||||||
|
import 'package:flutter/material.dart';
|
||||||
|
import 'package:wyatt_bloc_helper/wyatt_bloc_helper.dart';
|
||||||
|
|
||||||
|
class CounterCubitPage
|
||||||
|
extends CubitScreen<CounterCubit, CounterState> {
|
||||||
|
const CounterCubitPage({super.key});
|
||||||
|
|
||||||
|
@override
|
||||||
|
CounterCubit create(BuildContext context) => CounterCubit();
|
||||||
|
|
||||||
|
@override
|
||||||
|
Widget onBuild(BuildContext context, CounterState state) {
|
||||||
|
final textTheme = Theme.of(context).textTheme;
|
||||||
|
return Scaffold(
|
||||||
|
appBar: AppBar(title: const Text('Counter with Cubit')),
|
||||||
|
body: Center(child: Text('${state.count}', style: textTheme.headline2)),
|
||||||
|
floatingActionButton: Column(
|
||||||
|
mainAxisAlignment: MainAxisAlignment.end,
|
||||||
|
crossAxisAlignment: CrossAxisAlignment.end,
|
||||||
|
children: <Widget>[
|
||||||
|
FloatingActionButton(
|
||||||
|
heroTag: null,
|
||||||
|
key: const Key('counterCubitView_increment_floatingActionButton'),
|
||||||
|
child: const Icon(Icons.add),
|
||||||
|
onPressed: () => bloc(context).increment(),
|
||||||
|
),
|
||||||
|
const SizedBox(height: 8),
|
||||||
|
FloatingActionButton(
|
||||||
|
heroTag: null,
|
||||||
|
key: const Key('counterCubitView_decrement_floatingActionButton'),
|
||||||
|
child: const Icon(Icons.remove),
|
||||||
|
onPressed: () => bloc(context).decrement(),
|
||||||
|
),
|
||||||
|
],
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:bloc_helper_example/counter/bloc/counter_bloc.dart';
|
||||||
|
import 'package:flutter/material.dart';
|
||||||
|
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||||
|
import 'package:wyatt_bloc_helper/wyatt_bloc_helper.dart';
|
||||||
|
|
||||||
|
class CounterProviderPage
|
||||||
|
extends BlocProviderScreen<CounterBloc, CounterEvent, CounterState> {
|
||||||
|
const CounterProviderPage({super.key});
|
||||||
|
|
||||||
|
@override
|
||||||
|
Widget buildChild(BuildContext context) {
|
||||||
|
final textTheme = Theme.of(context).textTheme;
|
||||||
|
return Scaffold(
|
||||||
|
appBar: AppBar(title: const Text('Counter with Provider')),
|
||||||
|
body: Center(child: BlocBuilder<CounterBloc, CounterState>(
|
||||||
|
builder: (context, state) {
|
||||||
|
return Text('${state.count}', style: textTheme.headline2);
|
||||||
|
},
|
||||||
|
)),
|
||||||
|
floatingActionButton: Column(
|
||||||
|
mainAxisAlignment: MainAxisAlignment.end,
|
||||||
|
crossAxisAlignment: CrossAxisAlignment.end,
|
||||||
|
children: <Widget>[
|
||||||
|
FloatingActionButton(
|
||||||
|
heroTag: null,
|
||||||
|
key: const Key('counterProviderView_increment_floatingActionButton'),
|
||||||
|
child: const Icon(Icons.add),
|
||||||
|
onPressed: () => add(context, CounterIncrement()),
|
||||||
|
),
|
||||||
|
const SizedBox(height: 8),
|
||||||
|
FloatingActionButton(
|
||||||
|
heroTag: null,
|
||||||
|
key: const Key('counterProviderView_decrement_floatingActionButton'),
|
||||||
|
child: const Icon(Icons.remove),
|
||||||
|
onPressed: () => add(context, CounterDecrement()),
|
||||||
|
),
|
||||||
|
],
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
CounterBloc create(BuildContext context) => CounterBloc();
|
||||||
|
}
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:equatable/equatable.dart';
|
||||||
|
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||||
|
|
||||||
|
part 'counter_state.dart';
|
||||||
|
|
||||||
|
class CounterCubit extends Cubit<CounterState> {
|
||||||
|
CounterCubit() : super(const CounterInitial());
|
||||||
|
|
||||||
|
void increment() {
|
||||||
|
emit(CounterModified(state.count + 1));
|
||||||
|
}
|
||||||
|
|
||||||
|
void decrement() {
|
||||||
|
emit(CounterModified(state.count - 1));
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
part of 'counter_cubit.dart';
|
||||||
|
|
||||||
|
abstract class CounterState extends Equatable {
|
||||||
|
final int count;
|
||||||
|
|
||||||
|
const CounterState(this.count);
|
||||||
|
|
||||||
|
@override
|
||||||
|
List<Object> get props => [count];
|
||||||
|
}
|
||||||
|
|
||||||
|
class CounterInitial extends CounterState {
|
||||||
|
const CounterInitial() : super(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
class CounterModified extends CounterState {
|
||||||
|
const CounterModified(super.count);
|
||||||
|
}
|
||||||
|
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:flutter/foundation.dart';
|
||||||
|
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||||
|
|
||||||
|
class CounterObserver extends BlocObserver {
|
||||||
|
@override
|
||||||
|
void onChange(BlocBase bloc, Change change) {
|
||||||
|
super.onChange(bloc, change);
|
||||||
|
debugPrint('${bloc.runtimeType} $change');
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,90 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:bloc_helper_example/counter/counter_bloc_page.dart';
|
||||||
|
import 'package:bloc_helper_example/counter/counter_consumer_page.dart';
|
||||||
|
import 'package:bloc_helper_example/counter/counter_cubit_page.dart';
|
||||||
|
import 'package:bloc_helper_example/counter/counter_provider_page.dart';
|
||||||
|
import 'package:bloc_helper_example/counter/cubit/counter_cubit.dart';
|
||||||
|
import 'package:bloc_helper_example/counter_observer.dart';
|
||||||
|
import 'package:flutter/material.dart';
|
||||||
|
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||||
|
|
||||||
|
void main() {
|
||||||
|
BlocOverrides.runZoned(() => runApp(const MyApp()),
|
||||||
|
blocObserver: CounterObserver());
|
||||||
|
}
|
||||||
|
|
||||||
|
class MyApp extends StatelessWidget {
|
||||||
|
const MyApp({Key? key}) : super(key: key);
|
||||||
|
|
||||||
|
// This widget is the root of your application.
|
||||||
|
@override
|
||||||
|
Widget build(BuildContext context) {
|
||||||
|
return MaterialApp(
|
||||||
|
title: 'Flutter Demo',
|
||||||
|
theme: ThemeData(
|
||||||
|
primarySwatch: Colors.blue,
|
||||||
|
),
|
||||||
|
home: const MainPage(),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class MainPage extends StatelessWidget {
|
||||||
|
const MainPage({Key? key}) : super(key: key);
|
||||||
|
|
||||||
|
@override
|
||||||
|
Widget build(BuildContext context) {
|
||||||
|
return Scaffold(
|
||||||
|
appBar: AppBar(
|
||||||
|
title: const Text('Main Page'),
|
||||||
|
),
|
||||||
|
body: Center(
|
||||||
|
child: Column(
|
||||||
|
mainAxisAlignment: MainAxisAlignment.center,
|
||||||
|
children: <Widget>[
|
||||||
|
ElevatedButton(
|
||||||
|
child: const Text('Counter with BlocScreen'),
|
||||||
|
onPressed: () => Navigator.of(context).push(
|
||||||
|
MaterialPageRoute(builder: (_) => const CounterBlocPage())),
|
||||||
|
),
|
||||||
|
ElevatedButton(
|
||||||
|
child: const Text('Counter with CubitScreen'),
|
||||||
|
onPressed: () => Navigator.of(context).push(
|
||||||
|
MaterialPageRoute(builder: (_) => const CounterCubitPage())),
|
||||||
|
),
|
||||||
|
ElevatedButton(
|
||||||
|
child: const Text('Counter with BlocProviderScreen'),
|
||||||
|
onPressed: () => Navigator.of(context).push(MaterialPageRoute(
|
||||||
|
builder: (_) => const CounterProviderPage())),
|
||||||
|
),
|
||||||
|
ElevatedButton(
|
||||||
|
child: const Text('Counter with BlocConsumerScreen'),
|
||||||
|
onPressed: () => Navigator.of(context)
|
||||||
|
.push(MaterialPageRoute(builder: (context) {
|
||||||
|
return BlocProvider<CounterCubit>(
|
||||||
|
create: (context) => CounterCubit(),
|
||||||
|
child: const CounterConsumerPage(),
|
||||||
|
);
|
||||||
|
})),
|
||||||
|
),
|
||||||
|
],
|
||||||
|
),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,94 @@
|
|||||||
|
name: bloc_helper_example
|
||||||
|
description: A new Flutter project.
|
||||||
|
|
||||||
|
# The following line prevents the package from being accidentally published to
|
||||||
|
# pub.dev using `flutter pub publish`. This is preferred for private packages.
|
||||||
|
publish_to: 'none' # Remove this line if you wish to publish to pub.dev
|
||||||
|
|
||||||
|
# The following defines the version and build number for your application.
|
||||||
|
# A version number is three numbers separated by dots, like 1.2.43
|
||||||
|
# followed by an optional build number separated by a +.
|
||||||
|
# Both the version and the builder number may be overridden in flutter
|
||||||
|
# build by specifying --build-name and --build-number, respectively.
|
||||||
|
# In Android, build-name is used as versionName while build-number used as versionCode.
|
||||||
|
# Read more about Android versioning at https://developer.android.com/studio/publish/versioning
|
||||||
|
# In iOS, build-name is used as CFBundleShortVersionString while build-number used as CFBundleVersion.
|
||||||
|
# Read more about iOS versioning at
|
||||||
|
# https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html
|
||||||
|
version: 1.0.0+1
|
||||||
|
|
||||||
|
environment:
|
||||||
|
sdk: ">=2.17.0 <3.0.0"
|
||||||
|
|
||||||
|
# Dependencies specify other packages that your package needs in order to work.
|
||||||
|
# To automatically upgrade your package dependencies to the latest versions
|
||||||
|
# consider running `flutter pub upgrade --major-versions`. Alternatively,
|
||||||
|
# dependencies can be manually updated by changing the version numbers below to
|
||||||
|
# the latest version available on pub.dev. To see which dependencies have newer
|
||||||
|
# versions available, run `flutter pub outdated`.
|
||||||
|
dependencies:
|
||||||
|
flutter:
|
||||||
|
sdk: flutter
|
||||||
|
|
||||||
|
|
||||||
|
# The following adds the Cupertino Icons font to your application.
|
||||||
|
# Use with the CupertinoIcons class for iOS style icons.
|
||||||
|
cupertino_icons: ^1.0.2
|
||||||
|
equatable: ^2.0.3
|
||||||
|
flutter_bloc: ^8.0.1
|
||||||
|
|
||||||
|
wyatt_bloc_helper:
|
||||||
|
path: ../
|
||||||
|
|
||||||
|
dev_dependencies:
|
||||||
|
flutter_test:
|
||||||
|
sdk: flutter
|
||||||
|
|
||||||
|
# The "flutter_lints" package below contains a set of recommended lints to
|
||||||
|
# encourage good coding practices. The lint set provided by the package is
|
||||||
|
# activated in the `analysis_options.yaml` file located at the root of your
|
||||||
|
# package. See that file for information about deactivating specific lint
|
||||||
|
# rules and activating additional ones.
|
||||||
|
flutter_lints: ^2.0.0
|
||||||
|
|
||||||
|
# For information on the generic Dart part of this file, see the
|
||||||
|
# following page: https://dart.dev/tools/pub/pubspec
|
||||||
|
|
||||||
|
# The following section is specific to Flutter packages.
|
||||||
|
flutter:
|
||||||
|
|
||||||
|
# The following line ensures that the Material Icons font is
|
||||||
|
# included with your application, so that you can use the icons in
|
||||||
|
# the material Icons class.
|
||||||
|
uses-material-design: true
|
||||||
|
|
||||||
|
# To add assets to your application, add an assets section, like this:
|
||||||
|
# assets:
|
||||||
|
# - images/a_dot_burr.jpeg
|
||||||
|
# - images/a_dot_ham.jpeg
|
||||||
|
|
||||||
|
# An image asset can refer to one or more resolution-specific "variants", see
|
||||||
|
# https://flutter.dev/assets-and-images/#resolution-aware
|
||||||
|
|
||||||
|
# For details regarding adding assets from package dependencies, see
|
||||||
|
# https://flutter.dev/assets-and-images/#from-packages
|
||||||
|
|
||||||
|
# To add custom fonts to your application, add a fonts section here,
|
||||||
|
# in this "flutter" section. Each entry in this list should have a
|
||||||
|
# "family" key with the font family name, and a "fonts" key with a
|
||||||
|
# list giving the asset and other descriptors for the font. For
|
||||||
|
# example:
|
||||||
|
# fonts:
|
||||||
|
# - family: Schyler
|
||||||
|
# fonts:
|
||||||
|
# - asset: fonts/Schyler-Regular.ttf
|
||||||
|
# - asset: fonts/Schyler-Italic.ttf
|
||||||
|
# style: italic
|
||||||
|
# - family: Trajan Pro
|
||||||
|
# fonts:
|
||||||
|
# - asset: fonts/TrajanPro.ttf
|
||||||
|
# - asset: fonts/TrajanPro_Bold.ttf
|
||||||
|
# weight: 700
|
||||||
|
#
|
||||||
|
# For details regarding fonts from package dependencies,
|
||||||
|
# see https://flutter.dev/custom-fonts/#from-packages
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
// This is a basic Flutter widget test.
|
||||||
|
//
|
||||||
|
// To perform an interaction with a widget in your test, use the WidgetTester
|
||||||
|
// utility in the flutter_test package. For example, you can send tap and scroll
|
||||||
|
// gestures. You can also use WidgetTester to find child widgets in the widget
|
||||||
|
// tree, read text, and verify that the values of widget properties are correct.
|
||||||
|
|
||||||
|
import 'package:flutter/material.dart';
|
||||||
|
import 'package:flutter_test/flutter_test.dart';
|
||||||
|
|
||||||
|
import 'package:bloc_helper_example/main.dart';
|
||||||
|
|
||||||
|
void main() {
|
||||||
|
testWidgets('Counter increments smoke test', (WidgetTester tester) async {
|
||||||
|
// Build our app and trigger a frame.
|
||||||
|
await tester.pumpWidget(const MyApp());
|
||||||
|
|
||||||
|
// Verify that our counter starts at 0.
|
||||||
|
expect(find.text('0'), findsOneWidget);
|
||||||
|
expect(find.text('1'), findsNothing);
|
||||||
|
|
||||||
|
// Tap the '+' icon and trigger a frame.
|
||||||
|
await tester.tap(find.byIcon(Icons.add));
|
||||||
|
await tester.pump();
|
||||||
|
|
||||||
|
// Verify that our counter has incremented.
|
||||||
|
expect(find.text('0'), findsNothing);
|
||||||
|
expect(find.text('1'), findsOneWidget);
|
||||||
|
});
|
||||||
|
}
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||||
|
import 'package:wyatt_bloc_helper/src/bloc_base/bloc_base_consumer_screen.dart';
|
||||||
|
import 'package:wyatt_bloc_helper/src/bloc_base/bloc_base_provider_screen.dart';
|
||||||
|
import 'package:wyatt_bloc_helper/src/bloc_base/bloc_base_screen.dart';
|
||||||
|
import 'package:wyatt_bloc_helper/src/mixins/bloc_base_provider_mixin.dart';
|
||||||
|
import 'package:wyatt_bloc_helper/src/mixins/bloc_provider_mixin.dart';
|
||||||
|
|
||||||
|
abstract class BlocProviderScreen<B extends Bloc<E, S>, E, S extends Object>
|
||||||
|
extends BlocBaseProviderScreen<B, S>
|
||||||
|
with BlocBaseProviderMixin<B>, BlocProviderMixin<B, E> {
|
||||||
|
const BlocProviderScreen({super.key});
|
||||||
|
}
|
||||||
|
|
||||||
|
abstract class BlocConsumerScreen<B extends Bloc<E, S>, E, S extends Object>
|
||||||
|
extends BlocBaseConsumerScreen<B, S>
|
||||||
|
with BlocBaseProviderMixin<B>, BlocProviderMixin<B, E> {
|
||||||
|
const BlocConsumerScreen({super.key});
|
||||||
|
}
|
||||||
|
|
||||||
|
abstract class BlocScreen<B extends Bloc<E, S>, E, S extends Object>
|
||||||
|
extends BlocBaseScreen<B, S>
|
||||||
|
with BlocBaseProviderMixin<B>, BlocProviderMixin<B, E> {
|
||||||
|
const BlocScreen({super.key});
|
||||||
|
}
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:flutter/widgets.dart';
|
||||||
|
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||||
|
|
||||||
|
abstract class BlocBaseConsumerScreen<B extends BlocBase<S>, S extends Object>
|
||||||
|
extends StatelessWidget {
|
||||||
|
const BlocBaseConsumerScreen({super.key});
|
||||||
|
|
||||||
|
/// Takes the previous `state` and the current `state` and is responsible for
|
||||||
|
/// returning a [bool] which determines whether or not to trigger
|
||||||
|
/// [onBuild] with the current `state`.
|
||||||
|
bool shouldBuildWhen(S previous, S current) => true;
|
||||||
|
|
||||||
|
/// Takes the previous `state` and the current `state` and is responsible for
|
||||||
|
/// returning a [bool] which determines whether or not to trigger
|
||||||
|
/// [onListen] with the current `state`.
|
||||||
|
bool shouldListenWhen(S previous, S current) => true;
|
||||||
|
|
||||||
|
/// The [onBuild] function which will be invoked on each widget build.
|
||||||
|
/// The [onBuild] takes the `BuildContext` and current `state` and
|
||||||
|
/// must return a widget.
|
||||||
|
Widget onBuild(BuildContext context, S state);
|
||||||
|
|
||||||
|
/// Takes the `BuildContext` along with the `state`
|
||||||
|
/// and is responsible for executing in response to `state` changes.
|
||||||
|
void onListen(BuildContext context, S state) {}
|
||||||
|
|
||||||
|
@override
|
||||||
|
Widget build(BuildContext context) {
|
||||||
|
return BlocConsumer<B, S>(
|
||||||
|
listenWhen: shouldListenWhen,
|
||||||
|
listener: onListen,
|
||||||
|
buildWhen: shouldBuildWhen,
|
||||||
|
builder: onBuild,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:flutter/widgets.dart';
|
||||||
|
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||||
|
|
||||||
|
abstract class BlocBaseProviderScreen<B extends BlocBase<S>, S extends Object>
|
||||||
|
extends StatelessWidget {
|
||||||
|
const BlocBaseProviderScreen({super.key});
|
||||||
|
|
||||||
|
/// Creates the [Cubit] or [Bloc] to be used.
|
||||||
|
B create(BuildContext context);
|
||||||
|
|
||||||
|
/// Creates the child [Widget] to be used.
|
||||||
|
Widget buildChild(BuildContext context);
|
||||||
|
|
||||||
|
@override
|
||||||
|
Widget build(BuildContext context) {
|
||||||
|
return BlocProvider<B>(
|
||||||
|
create: (_) => create(context),
|
||||||
|
child: Builder(builder: buildChild),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:flutter/widgets.dart';
|
||||||
|
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||||
|
import 'package:wyatt_bloc_helper/src/bloc_base/bloc_base_consumer_screen.dart';
|
||||||
|
|
||||||
|
abstract class BlocBaseScreen<B extends BlocBase<S>, S extends Object>
|
||||||
|
extends BlocBaseConsumerScreen<B, S> {
|
||||||
|
const BlocBaseScreen({super.key});
|
||||||
|
|
||||||
|
/// Creates the [Cubit] or [Bloc] to be used.
|
||||||
|
B create(BuildContext context);
|
||||||
|
|
||||||
|
@override
|
||||||
|
Widget build(BuildContext context) {
|
||||||
|
return BlocProvider<B>(
|
||||||
|
create: (_) => create(context),
|
||||||
|
child: super.build(context),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||||
|
import 'package:wyatt_bloc_helper/src/bloc_base/bloc_base_consumer_screen.dart';
|
||||||
|
import 'package:wyatt_bloc_helper/src/bloc_base/bloc_base_provider_screen.dart';
|
||||||
|
import 'package:wyatt_bloc_helper/src/bloc_base/bloc_base_screen.dart';
|
||||||
|
import 'package:wyatt_bloc_helper/src/mixins/bloc_base_provider_mixin.dart';
|
||||||
|
|
||||||
|
abstract class CubitProviderScreen<B extends Cubit<S>, S extends Object>
|
||||||
|
extends BlocBaseProviderScreen<B, S> with BlocBaseProviderMixin<B> {
|
||||||
|
const CubitProviderScreen({super.key});
|
||||||
|
}
|
||||||
|
|
||||||
|
abstract class CubitConsumerScreen<B extends Cubit<S>, S extends Object>
|
||||||
|
extends BlocBaseConsumerScreen<B, S> with BlocBaseProviderMixin<B> {
|
||||||
|
const CubitConsumerScreen({super.key});
|
||||||
|
}
|
||||||
|
|
||||||
|
abstract class CubitScreen<B extends Cubit<S>, S extends Object>
|
||||||
|
extends BlocBaseScreen<B, S> with BlocBaseProviderMixin<B> {
|
||||||
|
const CubitScreen({super.key});
|
||||||
|
}
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:flutter/widgets.dart';
|
||||||
|
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||||
|
|
||||||
|
/// A mixin that provides implementation of helper methods for
|
||||||
|
/// [Bloc] and [Cubit] widgets.
|
||||||
|
mixin BlocBaseProviderMixin<B extends BlocBase<Object>> {
|
||||||
|
/// Returns the [BlocBase] used by this [BlocBaseProviderMixin].
|
||||||
|
B bloc(BuildContext context) => BlocProvider.of<B>(context);
|
||||||
|
|
||||||
|
/// Returns the [BlocBase] used by this [BlocBaseProviderMixin].
|
||||||
|
R repo<R>(BuildContext context) => RepositoryProvider.of<R>(context);
|
||||||
|
}
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:flutter/widgets.dart';
|
||||||
|
import 'package:flutter_bloc/flutter_bloc.dart';
|
||||||
|
|
||||||
|
/// [Bloc] specific mixin that provides implementation
|
||||||
|
/// of helper methods for events.
|
||||||
|
mixin BlocProviderMixin<B extends Bloc<E, Object>, E> {
|
||||||
|
void add(BuildContext context, E event) {
|
||||||
|
BlocProvider.of<B>(context).add(event);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
library wyatt_bloc_helper;
|
||||||
|
|
||||||
|
export 'src/bloc.dart';
|
||||||
|
export 'src/cubit.dart';
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
name: wyatt_bloc_helper
|
||||||
|
description: Your best friend for blocs in Flutter
|
||||||
|
repository: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_bloc_helper
|
||||||
|
version: 1.1.0
|
||||||
|
|
||||||
|
environment:
|
||||||
|
sdk: '>=2.17.0 <3.0.0'
|
||||||
|
|
||||||
|
dependencies:
|
||||||
|
flutter:
|
||||||
|
sdk: flutter
|
||||||
|
|
||||||
|
flutter_bloc: ^8.0.1
|
||||||
|
equatable: ^2.0.3
|
||||||
|
|
||||||
|
dev_dependencies:
|
||||||
|
flutter_test:
|
||||||
|
sdk: flutter
|
||||||
|
bloc_test: ^9.0.3
|
||||||
|
|
||||||
|
wyatt_analysis:
|
||||||
|
git:
|
||||||
|
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
|
||||||
|
ref: wyatt_analysis-v2.1.0
|
||||||
|
path: packages/wyatt_analysis
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
# Files and directories created by pub.
|
||||||
|
.dart_tool/
|
||||||
|
.packages
|
||||||
|
|
||||||
|
# Conventional directory for build outputs.
|
||||||
|
build/
|
||||||
|
|
||||||
|
# Omit committing pubspec.lock for library packages; see
|
||||||
|
# https://dart.dev/guides/libraries/private-files#pubspeclock.
|
||||||
|
pubspec.lock
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (C) 2022 WYATT GROUP
|
||||||
|
* Please see the AUTHORS file for details.
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
|
* any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
{
|
||||||
|
"recommendations": [
|
||||||
|
"psioniq.psi-header",
|
||||||
|
"blaugold.melos-code"
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
{
|
||||||
|
"psi-header.changes-tracking": {
|
||||||
|
"isActive": true
|
||||||
|
},
|
||||||
|
"psi-header.config": {
|
||||||
|
"blankLinesAfter": 1,
|
||||||
|
"forceToTop": true
|
||||||
|
},
|
||||||
|
"psi-header.lang-config": [
|
||||||
|
{
|
||||||
|
"beforeHeader": [
|
||||||
|
"# -*- coding:utf-8 -*-",
|
||||||
|
"#!/usr/bin/env python3"
|
||||||
|
],
|
||||||
|
"begin": "###",
|
||||||
|
"end": "###",
|
||||||
|
"language": "python",
|
||||||
|
"prefix": "# "
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"beforeHeader": [
|
||||||
|
"#!/usr/bin/env sh",
|
||||||
|
""
|
||||||
|
],
|
||||||
|
"language": "shellscript",
|
||||||
|
"begin": "",
|
||||||
|
"end": "",
|
||||||
|
"prefix": "# "
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"begin": "",
|
||||||
|
"end": "",
|
||||||
|
"language": "dart",
|
||||||
|
"prefix": "// "
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"begin": "",
|
||||||
|
"end": "",
|
||||||
|
"language": "yaml",
|
||||||
|
"prefix": "# "
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"begin": "<!--",
|
||||||
|
"end": "-->",
|
||||||
|
"language": "markdown",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
"psi-header.templates": [
|
||||||
|
{
|
||||||
|
"language": "*",
|
||||||
|
"template": [
|
||||||
|
"Copyright (C) <<year>> WYATT GROUP",
|
||||||
|
"Please see the AUTHORS file for details.",
|
||||||
|
"",
|
||||||
|
"This program is free software: you can redistribute it and/or modify",
|
||||||
|
"it under the terms of the GNU General Public License as published by",
|
||||||
|
"the Free Software Foundation, either version 3 of the License, or",
|
||||||
|
"any later version.",
|
||||||
|
"",
|
||||||
|
"This program is distributed in the hope that it will be useful,",
|
||||||
|
"but WITHOUT ANY WARRANTY; without even the implied warranty of",
|
||||||
|
"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the",
|
||||||
|
"GNU General Public License for more details.",
|
||||||
|
"",
|
||||||
|
"You should have received a copy of the GNU General Public License",
|
||||||
|
"along with this program. If not, see <https://www.gnu.org/licenses/>."
|
||||||
|
],
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"dart.runPubGetOnPubspecChanges": false,
|
||||||
|
}
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
# Below is a list of people and organizations that have contributed
|
||||||
|
# to this project. Names should be added to the list like so:
|
||||||
|
#
|
||||||
|
# Name/Organization <email address>
|
||||||
|
|
||||||
|
Wyatt Group S.A.S
|
||||||
|
Hugo Pointcheval <git@pcl.ovh>
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
## 1.0.0
|
||||||
|
|
||||||
|
- Initial version.
|
||||||
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
<!--
|
||||||
|
* Copyright (C) 2022 WYATT GROUP
|
||||||
|
* Please see the AUTHORS file for details.
|
||||||
|
*
|
||||||
|
* This program is free software: you can redistribute it and/or modify
|
||||||
|
* it under the terms of the GNU General Public License as published by
|
||||||
|
* the Free Software Foundation, either version 3 of the License, or
|
||||||
|
* any later version.
|
||||||
|
*
|
||||||
|
* This program is distributed in the hope that it will be useful,
|
||||||
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
* GNU General Public License for more details.
|
||||||
|
*
|
||||||
|
* You should have received a copy of the GNU General Public License
|
||||||
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
-->
|
||||||
|
|
||||||
|
# Dart - CLI Toolbox
|
||||||
|
|
||||||
|
<p align="left">
|
||||||
|
<a href="https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages/src/branch/master/packages/wyatt_analysis">
|
||||||
|
<img src="https://img.shields.io/badge/Style-Wyatt%20Analysis-blue.svg?style=flat-square" alt="Style: Wyatt Analysis" />
|
||||||
|
</a>
|
||||||
|
<img src="https://img.shields.io/badge/SDK-Dart-blue?style=flat-square" alt="SDK: Dart" />
|
||||||
|
<img src="https://img.shields.io/badge/Status-WIP-red?style=flat-square" alt="WIP" />
|
||||||
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
TODO: Put a short description of the package here that helps potential users
|
||||||
|
know whether this package might be useful for them.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
TODO: List what your package can do. Maybe include images, gifs, or videos.
|
||||||
|
|
||||||
|
## Getting started
|
||||||
|
|
||||||
|
TODO: List prerequisites and provide or point to information on how to
|
||||||
|
start using the package.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
TODO: Include short and useful examples for package users. Add longer examples
|
||||||
|
to `/example` folder.
|
||||||
|
|
||||||
|
```dart
|
||||||
|
const like = 'sample';
|
||||||
|
```
|
||||||
|
|
||||||
|
## Additional information
|
||||||
|
|
||||||
|
TODO: Tell users more about the package: where to find more information, how to
|
||||||
|
contribute to the package, how to file issues, what response they can expect
|
||||||
|
from the package authors, and more.
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
include: package:wyatt_analysis/analysis_options.yaml
|
||||||
@@ -0,0 +1,273 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:io';
|
||||||
|
import 'dart:math';
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/wyatt_cli_toolbox.dart';
|
||||||
|
|
||||||
|
void testStylish() {
|
||||||
|
print('my beautiful text in magenta'.magenta());
|
||||||
|
print('you can combine multiple styles'.yellow().bgBlue().bold());
|
||||||
|
|
||||||
|
print('\x1B[36mstart style');
|
||||||
|
print('style continues on this line');
|
||||||
|
print('but not on this line'.reset());
|
||||||
|
|
||||||
|
print('\x1B[41mnot stripped\x1B[49m');
|
||||||
|
print('\x1B[41mstripped\x1B[49m'.strip());
|
||||||
|
|
||||||
|
Stylish.config(enable: false);
|
||||||
|
print('you can disable extension'.fg(r: 20, g: 160, b: 80));
|
||||||
|
Stylish.config(enable: true);
|
||||||
|
print('and reenable it on the fly'.fg(r: 20, g: 160, b: 80));
|
||||||
|
print('custom bg color'.bg(r: 80, g: 110, b: 30));
|
||||||
|
}
|
||||||
|
|
||||||
|
void testSequences() {
|
||||||
|
Sequences.clearEntireScreen();
|
||||||
|
print('Clear entire screen');
|
||||||
|
|
||||||
|
print('Hide cursor');
|
||||||
|
Sequences.hideCursor();
|
||||||
|
sleep(Duration(seconds: 1));
|
||||||
|
print('Unhide cursor');
|
||||||
|
Sequences.unhideCursor();
|
||||||
|
sleep(Duration(seconds: 1));
|
||||||
|
|
||||||
|
print('Save cursor position');
|
||||||
|
Sequences.savePosition();
|
||||||
|
sleep(Duration(seconds: 1));
|
||||||
|
|
||||||
|
print('Move cursor');
|
||||||
|
Sequences.moveCursor(6, 3);
|
||||||
|
sleep(Duration(seconds: 1));
|
||||||
|
|
||||||
|
Sequences.restorePosition();
|
||||||
|
Sequences.moveDown(1);
|
||||||
|
sleep(Duration(seconds: 1));
|
||||||
|
print('Restore cursor position');
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<void> testSpinners() async {
|
||||||
|
print('Starting computation 1...');
|
||||||
|
await Spinner.start(SpinnerType.fistBump);
|
||||||
|
sleep(Duration(seconds: 2));
|
||||||
|
Spinner.stop();
|
||||||
|
|
||||||
|
print('Starting computation 2...');
|
||||||
|
await Spinner.start(SpinnerType.dots5, text: 'Loading...');
|
||||||
|
sleep(Duration(seconds: 3));
|
||||||
|
Spinner.stop();
|
||||||
|
|
||||||
|
print('Starting computation 3...');
|
||||||
|
await Spinner.custom(
|
||||||
|
Indicator(
|
||||||
|
name: 'Eyes',
|
||||||
|
interval: 100,
|
||||||
|
frames: <String>['◡◡', '⊙⊙', '◠◠']
|
||||||
|
.map<String>((String e) => '\x1B[36m$e\x1B[39m')
|
||||||
|
.toList(),
|
||||||
|
label: 'Computing...',
|
||||||
|
),
|
||||||
|
);
|
||||||
|
await Future<void>.delayed(Duration(seconds: 2));
|
||||||
|
Spinner.stop();
|
||||||
|
|
||||||
|
print('Starting computation 4...');
|
||||||
|
await Spinner.start(SpinnerType.pipe, text: 'Linking...');
|
||||||
|
sleep(Duration(seconds: 3));
|
||||||
|
Spinner.update(
|
||||||
|
SpinnerType.circle.indicator.copyWith(label: 'Compiling...'),
|
||||||
|
);
|
||||||
|
sleep(Duration(seconds: 3));
|
||||||
|
Spinner.stop();
|
||||||
|
}
|
||||||
|
|
||||||
|
void testPrompt() {
|
||||||
|
final Prompt pr = Prompt();
|
||||||
|
final StringQuestion q1 = StringQuestion(
|
||||||
|
"What's your name ?",
|
||||||
|
identifier: 'name',
|
||||||
|
);
|
||||||
|
final PasswordQuestion q8 = PasswordQuestion(
|
||||||
|
'Password ?',
|
||||||
|
comment: 'Secret shhht.',
|
||||||
|
identifier: 'password',
|
||||||
|
);
|
||||||
|
final NumberQuestion q7 = NumberQuestion(
|
||||||
|
'How old are you?',
|
||||||
|
identifier: 'age',
|
||||||
|
);
|
||||||
|
final BooleanQuestion q2 = BooleanQuestion(
|
||||||
|
'Do you like Dart ?',
|
||||||
|
identifier: 'dart',
|
||||||
|
);
|
||||||
|
final ListQuestion q3 = ListQuestion(
|
||||||
|
'Which target ?',
|
||||||
|
<String>['android', 'ios', 'windows', 'macos'],
|
||||||
|
identifier: 'platform',
|
||||||
|
);
|
||||||
|
final Message q4 = Message(
|
||||||
|
'Oh oh !',
|
||||||
|
level: MessageLevel.warn,
|
||||||
|
identifier: 'warn',
|
||||||
|
);
|
||||||
|
final Message q5 = Message(
|
||||||
|
'Oh damn :(',
|
||||||
|
level: MessageLevel.fail,
|
||||||
|
identifier: 'error',
|
||||||
|
);
|
||||||
|
final Message q6 = Message(
|
||||||
|
'Thank you, bye! 🤙',
|
||||||
|
comment: 'Pretty comment nah?',
|
||||||
|
identifier: 'bye',
|
||||||
|
);
|
||||||
|
|
||||||
|
pr
|
||||||
|
..addAll(<Question<dynamic>>[q1, q8, q7, q2, q3, q4, q5, q6])
|
||||||
|
..ask();
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<void> testWorkflow() async {
|
||||||
|
final Task<int> t1 = Task<int>(
|
||||||
|
name: 'Analyzing',
|
||||||
|
id: 'analyze',
|
||||||
|
spinner: SpinnerType.circle,
|
||||||
|
task: () {
|
||||||
|
return waitFor<int>(
|
||||||
|
Future<int>.delayed(Duration(seconds: 3), () => 13),
|
||||||
|
);
|
||||||
|
},
|
||||||
|
onFinish: (Object? i) {
|
||||||
|
return '$i files analyzed';
|
||||||
|
},
|
||||||
|
);
|
||||||
|
final Task<int> t2 = Task<int>(
|
||||||
|
name: 'Formatting',
|
||||||
|
id: 'format',
|
||||||
|
spinner: SpinnerType.circle,
|
||||||
|
task: () {
|
||||||
|
return waitFor<int>(
|
||||||
|
Future<int>.delayed(Duration(seconds: 4), () => 1287),
|
||||||
|
);
|
||||||
|
},
|
||||||
|
onFinish: (Object? i) {
|
||||||
|
return '$i files modified';
|
||||||
|
},
|
||||||
|
);
|
||||||
|
final Task<void> t3 = Task<void>(
|
||||||
|
name: 'Building',
|
||||||
|
id: 'build',
|
||||||
|
task: () {
|
||||||
|
final List<String> _tasks = <String>[
|
||||||
|
'main.c',
|
||||||
|
'crypto.c',
|
||||||
|
'workflow.c',
|
||||||
|
'wyatt.c',
|
||||||
|
'logger.c',
|
||||||
|
'task.c',
|
||||||
|
];
|
||||||
|
for (final String i in _tasks) {
|
||||||
|
Task.print(i);
|
||||||
|
sleep(Duration(seconds: Random().nextInt(4) + 1));
|
||||||
|
}
|
||||||
|
},
|
||||||
|
onFinish: (_) {
|
||||||
|
return 'Compilation success';
|
||||||
|
},
|
||||||
|
);
|
||||||
|
final Task<void> t4 = Task<void>(
|
||||||
|
name: 'Testing',
|
||||||
|
id: 'test',
|
||||||
|
task: () {
|
||||||
|
final List<String> _tasks = <String>[
|
||||||
|
'wyatt.h',
|
||||||
|
'crypto.h',
|
||||||
|
];
|
||||||
|
for (final String i in _tasks) {
|
||||||
|
Task.print(i);
|
||||||
|
sleep(Duration(seconds: Random().nextInt(3)));
|
||||||
|
}
|
||||||
|
throw Exception('An error occured during ${'test::crypto.h'.red()}');
|
||||||
|
},
|
||||||
|
onFinish: (_) {
|
||||||
|
return 'All tests passed';
|
||||||
|
},
|
||||||
|
onError: (Object e) {
|
||||||
|
return e.toString();
|
||||||
|
},
|
||||||
|
);
|
||||||
|
final Task<void> t5 = Task<void>(
|
||||||
|
name: 'Bundling',
|
||||||
|
id: 'bundle',
|
||||||
|
task: () {
|
||||||
|
sleep(Duration(seconds: 3));
|
||||||
|
throw SkipException('Bundle skipped.');
|
||||||
|
},
|
||||||
|
onFinish: (_) {
|
||||||
|
return 'Files generated in dist/';
|
||||||
|
},
|
||||||
|
onSkip: (SkipException e) {
|
||||||
|
return e.toString();
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
final Workflow w = await Workflow.create(<Task<dynamic>>[t1, t2, t3, t4, t5]);
|
||||||
|
w.start();
|
||||||
|
|
||||||
|
print('\n${w.results.toString().dim()}');
|
||||||
|
}
|
||||||
|
|
||||||
|
void testNewPrompt() {
|
||||||
|
final name = Input(message: 'Your name').prompt();
|
||||||
|
stdout.writeln(name);
|
||||||
|
|
||||||
|
final email = Input(
|
||||||
|
message: 'Your email',
|
||||||
|
validator: (String x) {
|
||||||
|
if (x.contains('@')) {
|
||||||
|
return true;
|
||||||
|
} else {
|
||||||
|
throw ValidationError('Not a valid email');
|
||||||
|
}
|
||||||
|
},
|
||||||
|
).prompt();
|
||||||
|
stdout.writeln(email);
|
||||||
|
|
||||||
|
final planet = Input(
|
||||||
|
message: 'Your planet',
|
||||||
|
defaultValue: 'Earth',
|
||||||
|
).prompt();
|
||||||
|
stdout.writeln(planet);
|
||||||
|
|
||||||
|
final galaxy = Input(
|
||||||
|
message: 'Your galaxy',
|
||||||
|
initialValue: 'Andromeda',
|
||||||
|
).prompt();
|
||||||
|
stdout.writeln(galaxy);
|
||||||
|
}
|
||||||
|
|
||||||
|
Future<void> main() async {
|
||||||
|
// sleep(Duration(seconds: 2));
|
||||||
|
// testPrompt();
|
||||||
|
// await testWorkflow();
|
||||||
|
// testStylish();
|
||||||
|
// testSequences();
|
||||||
|
// await testSpinners();
|
||||||
|
// testPrompt();
|
||||||
|
testNewPrompt();
|
||||||
|
}
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:convert';
|
||||||
|
import 'dart:io';
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/prompt/question.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/sequences/sequences.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/stylish/stylish.dart';
|
||||||
|
|
||||||
|
class BooleanQuestion extends Question<bool> {
|
||||||
|
BooleanQuestion(
|
||||||
|
String question, {
|
||||||
|
this.defaultTo = false,
|
||||||
|
String? comment,
|
||||||
|
required String identifier,
|
||||||
|
}) : super(QuestionType.booleanQuestion, identifier, question, comment);
|
||||||
|
|
||||||
|
bool? answer;
|
||||||
|
final bool defaultTo;
|
||||||
|
|
||||||
|
@override
|
||||||
|
String formatComment() => (super.formatComment().trim().isEmpty)
|
||||||
|
? defaultTo
|
||||||
|
? ' (Y/n) '.dim()
|
||||||
|
: ' (y/N) '.dim()
|
||||||
|
: super.formatComment();
|
||||||
|
|
||||||
|
@override
|
||||||
|
bool ask() {
|
||||||
|
stdout.write(formatQuestion());
|
||||||
|
String input = '';
|
||||||
|
input = stdin.readLineSync(encoding: utf8)!.trim();
|
||||||
|
stdout.write(Sequences.escMoveUp(1) + formatQuestion());
|
||||||
|
if (input.isEmpty) {
|
||||||
|
answer = defaultTo;
|
||||||
|
} else {
|
||||||
|
answer = input[0] == 'y' || input[0] == 'Y';
|
||||||
|
}
|
||||||
|
String replaceStr =
|
||||||
|
'\r${formatQuestion()}${Sequences.escClearLineFromCursorToEnd()}';
|
||||||
|
replaceStr += answer! ? 'Yes'.blue() : 'No'.blue();
|
||||||
|
stdout.writeln(replaceStr);
|
||||||
|
|
||||||
|
return answer!;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,49 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:io';
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/sequences/sequences.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/stylish/stylish.dart';
|
||||||
|
|
||||||
|
/// Abstract class providing XTerm escape sequences
|
||||||
|
abstract class Control {
|
||||||
|
/// Use Squences.escMoveUp, concatenate your string ([str])
|
||||||
|
/// and then blank the remaining line.
|
||||||
|
static String replacePreviousLine(String str) =>
|
||||||
|
Sequences.escMoveUp(1) + str + Sequences.escClearLineFromCursorToEnd();
|
||||||
|
|
||||||
|
/// Reset XTerm sequence.
|
||||||
|
/// This is always applied after using some other sequence.
|
||||||
|
static String reset = ''.reset();
|
||||||
|
|
||||||
|
/// See: https://codepoints.net/dingbats
|
||||||
|
static String questionIndicator() => '?'.green();
|
||||||
|
|
||||||
|
static String exclamationIndicator() => '!'.yellow();
|
||||||
|
|
||||||
|
static String infoIndicator() =>
|
||||||
|
Platform.isWindows ? 'i'.cyan() : '\u2139'.cyan();
|
||||||
|
|
||||||
|
static String rightIndicator() =>
|
||||||
|
Platform.isWindows ? '>'.blue() : '\u276F'.blue();
|
||||||
|
|
||||||
|
static String validIndicator() =>
|
||||||
|
Platform.isWindows ? 'v'.green() : '\u2714'.green();
|
||||||
|
|
||||||
|
static String wrongIndicator() =>
|
||||||
|
Platform.isWindows ? 'x'.red() : '\u2718'.red();
|
||||||
|
}
|
||||||
@@ -0,0 +1,95 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
part of prompt.framework;
|
||||||
|
|
||||||
|
class BuildContext {
|
||||||
|
int _buildCount = 0;
|
||||||
|
int get buildCount => _buildCount;
|
||||||
|
void incrementBuildCount() => _buildCount++;
|
||||||
|
void resetBuildCount() => _buildCount = 0;
|
||||||
|
|
||||||
|
int _lineCount = 0;
|
||||||
|
int get lineCount => _lineCount;
|
||||||
|
void incrementLineCount() => _lineCount++;
|
||||||
|
void resetLineCount() => _lineCount = 0;
|
||||||
|
|
||||||
|
static void reset() {
|
||||||
|
Sequences.unhideCursor();
|
||||||
|
Sequences.write(''.reset());
|
||||||
|
}
|
||||||
|
|
||||||
|
void hideCursor() {
|
||||||
|
Sequences.hideCursor();
|
||||||
|
}
|
||||||
|
|
||||||
|
void showCursor() {
|
||||||
|
Sequences.unhideCursor();
|
||||||
|
}
|
||||||
|
|
||||||
|
void write(String text) {
|
||||||
|
Sequences.write(text);
|
||||||
|
}
|
||||||
|
|
||||||
|
void writeln(String text) {
|
||||||
|
incrementLineCount();
|
||||||
|
Sequences.writeln(text);
|
||||||
|
}
|
||||||
|
|
||||||
|
void erasePreviousLine([int n = 1]) {
|
||||||
|
for (int i = 0; i < n; i++) {
|
||||||
|
Sequences.moveUp(1);
|
||||||
|
Sequences.clearEntireLine();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void wipe() {
|
||||||
|
erasePreviousLine(lineCount);
|
||||||
|
resetLineCount();
|
||||||
|
}
|
||||||
|
|
||||||
|
int readKey() => stdin.readByteSync();
|
||||||
|
|
||||||
|
String readLine({
|
||||||
|
String initialValue = '',
|
||||||
|
}) {
|
||||||
|
var buffer = initialValue;
|
||||||
|
var index = buffer.length;
|
||||||
|
|
||||||
|
Sequences.savePosition();
|
||||||
|
|
||||||
|
if (buffer.isNotEmpty) {
|
||||||
|
write(buffer);
|
||||||
|
}
|
||||||
|
|
||||||
|
while (true) {
|
||||||
|
final key = readKey();
|
||||||
|
if (index == buffer.length) {
|
||||||
|
buffer += String.fromCharCode(key);
|
||||||
|
index++;
|
||||||
|
} else {
|
||||||
|
buffer = buffer.substring(0, index) +
|
||||||
|
String.fromCharCode(key) +
|
||||||
|
buffer.substring(index);
|
||||||
|
index++;
|
||||||
|
}
|
||||||
|
|
||||||
|
Sequences.restorePosition();
|
||||||
|
Sequences.clearLineFromCursorToEnd();
|
||||||
|
write(buffer);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
library prompt.framework;
|
||||||
|
|
||||||
|
import 'dart:io';
|
||||||
|
import 'package:meta/meta.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/sequences/sequences.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/stylish/stylish.dart';
|
||||||
|
|
||||||
|
part 'build_context.dart';
|
||||||
|
part 'state.dart';
|
||||||
|
part 'widget.dart';
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
part of prompt.framework;
|
||||||
|
|
||||||
|
abstract class State<W extends Widget<dynamic>> {
|
||||||
|
W? _widget;
|
||||||
|
W get widget => _widget!;
|
||||||
|
|
||||||
|
BuildContext? _context;
|
||||||
|
BuildContext get context => _context!;
|
||||||
|
|
||||||
|
void build();
|
||||||
|
|
||||||
|
dynamic prompt();
|
||||||
|
|
||||||
|
@protected
|
||||||
|
@mustCallSuper
|
||||||
|
void dispose() {
|
||||||
|
_context = null;
|
||||||
|
}
|
||||||
|
|
||||||
|
@protected
|
||||||
|
@mustCallSuper
|
||||||
|
void initState() {
|
||||||
|
_context ??= BuildContext();
|
||||||
|
}
|
||||||
|
|
||||||
|
@protected
|
||||||
|
@mustCallSuper
|
||||||
|
void setState(void Function() fn) {
|
||||||
|
fn();
|
||||||
|
context.wipe();
|
||||||
|
build();
|
||||||
|
context.incrementBuildCount();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,150 @@
|
|||||||
|
// ignore_for_file: public_member_api_docs, sort_constructors_first
|
||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:io';
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/spinners/spinners.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/stylish/stylish.dart';
|
||||||
|
|
||||||
|
typedef StyleFunction = String Function(String);
|
||||||
|
|
||||||
|
class Theme {
|
||||||
|
final String inputPrefix;
|
||||||
|
final String inputSuffix;
|
||||||
|
final String successPrefix;
|
||||||
|
final String successSuffix;
|
||||||
|
final String errorPrefix;
|
||||||
|
final String hiddenPrefix;
|
||||||
|
final StyleFunction messageStyle;
|
||||||
|
final StyleFunction errorStyle;
|
||||||
|
final StyleFunction hintStyle;
|
||||||
|
final StyleFunction valueStyle;
|
||||||
|
final StyleFunction defaultStyle;
|
||||||
|
|
||||||
|
final String activeItemPrefix;
|
||||||
|
final String inactiveItemPrefix;
|
||||||
|
final StyleFunction activeItemStyle;
|
||||||
|
final StyleFunction inactiveItemStyle;
|
||||||
|
|
||||||
|
final String checkedItemPrefix;
|
||||||
|
final String uncheckedItemPrefix;
|
||||||
|
|
||||||
|
final String pickedItemPrefix;
|
||||||
|
final String unpickedItemPrefix;
|
||||||
|
|
||||||
|
final bool showActiveCursor;
|
||||||
|
|
||||||
|
final SpinnerType spinner;
|
||||||
|
|
||||||
|
const Theme({
|
||||||
|
required this.inputPrefix,
|
||||||
|
required this.inputSuffix,
|
||||||
|
required this.successPrefix,
|
||||||
|
required this.successSuffix,
|
||||||
|
required this.errorPrefix,
|
||||||
|
required this.hiddenPrefix,
|
||||||
|
required this.messageStyle,
|
||||||
|
required this.errorStyle,
|
||||||
|
required this.hintStyle,
|
||||||
|
required this.valueStyle,
|
||||||
|
required this.defaultStyle,
|
||||||
|
required this.activeItemPrefix,
|
||||||
|
required this.inactiveItemPrefix,
|
||||||
|
required this.activeItemStyle,
|
||||||
|
required this.inactiveItemStyle,
|
||||||
|
required this.checkedItemPrefix,
|
||||||
|
required this.uncheckedItemPrefix,
|
||||||
|
required this.pickedItemPrefix,
|
||||||
|
required this.unpickedItemPrefix,
|
||||||
|
required this.showActiveCursor,
|
||||||
|
required this.spinner,
|
||||||
|
});
|
||||||
|
|
||||||
|
Theme copyWith({
|
||||||
|
String? inputPrefix,
|
||||||
|
String? inputSuffix,
|
||||||
|
String? successPrefix,
|
||||||
|
String? successSuffix,
|
||||||
|
String? errorPrefix,
|
||||||
|
String? hiddenPrefix,
|
||||||
|
StyleFunction? messageStyle,
|
||||||
|
StyleFunction? errorStyle,
|
||||||
|
StyleFunction? hintStyle,
|
||||||
|
StyleFunction? valueStyle,
|
||||||
|
StyleFunction? defaultStyle,
|
||||||
|
String? activeItemPrefix,
|
||||||
|
String? inactiveItemPrefix,
|
||||||
|
StyleFunction? activeItemStyle,
|
||||||
|
StyleFunction? inactiveItemStyle,
|
||||||
|
String? checkedItemPrefix,
|
||||||
|
String? uncheckedItemPrefix,
|
||||||
|
String? pickedItemPrefix,
|
||||||
|
String? unpickedItemPrefix,
|
||||||
|
bool? showActiveCursor,
|
||||||
|
SpinnerType? spinner,
|
||||||
|
}) {
|
||||||
|
return Theme(
|
||||||
|
inputPrefix: inputPrefix ?? this.inputPrefix,
|
||||||
|
inputSuffix: inputSuffix ?? this.inputSuffix,
|
||||||
|
successPrefix: successPrefix ?? this.successPrefix,
|
||||||
|
successSuffix: successSuffix ?? this.successSuffix,
|
||||||
|
errorPrefix: errorPrefix ?? this.errorPrefix,
|
||||||
|
hiddenPrefix: hiddenPrefix ?? this.hiddenPrefix,
|
||||||
|
messageStyle: messageStyle ?? this.messageStyle,
|
||||||
|
errorStyle: errorStyle ?? this.errorStyle,
|
||||||
|
hintStyle: hintStyle ?? this.hintStyle,
|
||||||
|
valueStyle: valueStyle ?? this.valueStyle,
|
||||||
|
defaultStyle: defaultStyle ?? this.defaultStyle,
|
||||||
|
activeItemPrefix: activeItemPrefix ?? this.activeItemPrefix,
|
||||||
|
inactiveItemPrefix: inactiveItemPrefix ?? this.inactiveItemPrefix,
|
||||||
|
activeItemStyle: activeItemStyle ?? this.activeItemStyle,
|
||||||
|
inactiveItemStyle: inactiveItemStyle ?? this.inactiveItemStyle,
|
||||||
|
checkedItemPrefix: checkedItemPrefix ?? this.checkedItemPrefix,
|
||||||
|
uncheckedItemPrefix: uncheckedItemPrefix ?? this.uncheckedItemPrefix,
|
||||||
|
pickedItemPrefix: pickedItemPrefix ?? this.pickedItemPrefix,
|
||||||
|
unpickedItemPrefix: unpickedItemPrefix ?? this.unpickedItemPrefix,
|
||||||
|
showActiveCursor: showActiveCursor ?? this.showActiveCursor,
|
||||||
|
spinner: spinner ?? this.spinner,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
static Theme defaultTheme = colorfulTheme;
|
||||||
|
|
||||||
|
static final colorfulTheme = Theme(
|
||||||
|
inputPrefix: '?'.padRight(2).green(),
|
||||||
|
inputSuffix: (Platform.isWindows ? '>' : '\u276F').padLeft(2).grey(),
|
||||||
|
successPrefix: (Platform.isWindows ? 'v' : '\u2714').padRight(2).green(),
|
||||||
|
successSuffix: '•'.padLeft(2).grey(),
|
||||||
|
errorPrefix: (Platform.isWindows ? 'x' : '\u2718').padRight(2).red(),
|
||||||
|
hiddenPrefix: '*****',
|
||||||
|
messageStyle: (String message) => message.bold(),
|
||||||
|
errorStyle: (String error) => error.red(),
|
||||||
|
hintStyle: (String hint) => '($hint)'.grey(),
|
||||||
|
valueStyle: (String value) => value.green(),
|
||||||
|
defaultStyle: (String value) => value.cyan(),
|
||||||
|
activeItemPrefix: (Platform.isWindows ? '>' : '\u276F').green(),
|
||||||
|
inactiveItemPrefix: ' ',
|
||||||
|
activeItemStyle: (String item) => item.cyan(),
|
||||||
|
inactiveItemStyle: (String item) => item,
|
||||||
|
checkedItemPrefix: (Platform.isWindows ? 'v' : '\u2714').green(),
|
||||||
|
uncheckedItemPrefix: ' ',
|
||||||
|
pickedItemPrefix: (Platform.isWindows ? '>' : '\u276F').green(),
|
||||||
|
unpickedItemPrefix: ' ',
|
||||||
|
showActiveCursor: false,
|
||||||
|
spinner: SpinnerType.arrow,
|
||||||
|
);
|
||||||
|
}
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
part of prompt.framework;
|
||||||
|
|
||||||
|
abstract class Widget<T extends dynamic> {
|
||||||
|
int _initLineCount = 0;
|
||||||
|
|
||||||
|
/// Creates the mutable state for this widget
|
||||||
|
@protected
|
||||||
|
@factory
|
||||||
|
State createState();
|
||||||
|
|
||||||
|
State pipeState(State state) => state;
|
||||||
|
|
||||||
|
T prompt() {
|
||||||
|
final state = pipeState(createState())
|
||||||
|
.._widget = this
|
||||||
|
..initState();
|
||||||
|
_initLineCount = state.context.lineCount;
|
||||||
|
state.context.resetLineCount();
|
||||||
|
|
||||||
|
state.build();
|
||||||
|
state.context.incrementBuildCount();
|
||||||
|
|
||||||
|
final dynamic out = state.prompt();
|
||||||
|
state.context.wipe();
|
||||||
|
state.context.erasePreviousLine(_initLineCount);
|
||||||
|
state.dispose();
|
||||||
|
|
||||||
|
return out as T;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
// ignore_for_file: constant_identifier_names
|
||||||
|
|
||||||
|
import 'dart:io';
|
||||||
|
|
||||||
|
const int ARROW_UP = 65;
|
||||||
|
const int ARROW_DOWN = 66;
|
||||||
|
const int ENTER = 10;
|
||||||
|
const int SPACE = 32;
|
||||||
|
|
||||||
|
const int WIN_UP = 119;
|
||||||
|
const int WIN_DOWN = 115;
|
||||||
|
const int WIN_ENTER = 13;
|
||||||
|
const int WIN_SPACE = 20;
|
||||||
|
|
||||||
|
/// Abstract class providing some key codes which can be statically accessed.
|
||||||
|
abstract class Keys {
|
||||||
|
/// Arrow down. Consists of three bytes.
|
||||||
|
/// For historical reasons, you can also use 's'
|
||||||
|
/// instead of arrow down on Windows.
|
||||||
|
///
|
||||||
|
/// It is packed into a single element list in
|
||||||
|
/// order to not break the spread syntax.
|
||||||
|
static final List<int> arrowDown =
|
||||||
|
Platform.isWindows ? <int>[WIN_DOWN] : <int>[27, 91, 66];
|
||||||
|
|
||||||
|
/// Arrows up. Consists of three bytes in Unix like systems (including MacOS).
|
||||||
|
/// For historical reasons, you can also use 'w' insted of arrow
|
||||||
|
/// up on Windows.
|
||||||
|
///
|
||||||
|
/// It is packed into a single element list in
|
||||||
|
/// order to not break the spread syntax.
|
||||||
|
static final List<int> arrowUp =
|
||||||
|
Platform.isWindows ? <int>[WIN_UP] : <int>[27, 91, 65];
|
||||||
|
|
||||||
|
/// Enter key. Single byte.
|
||||||
|
static final int enter = Platform.isWindows ? WIN_ENTER : ENTER;
|
||||||
|
|
||||||
|
/// Space key. Single byte.
|
||||||
|
static final int space = Platform.isWindows ? WIN_SPACE : SPACE;
|
||||||
|
}
|
||||||
@@ -0,0 +1,129 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:io';
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/prompt/control.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/prompt/keys.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/sequences/sequences.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/stylish/stylish.dart';
|
||||||
|
|
||||||
|
class ListChooser {
|
||||||
|
ListChooser(this.options) {
|
||||||
|
if (stdin.hasTerminal) {
|
||||||
|
// lineMode must be true to set echoMode in Windows
|
||||||
|
// see https://github.com/dart-lang/sdk/issues/28599
|
||||||
|
stdin.echoMode = false;
|
||||||
|
stdin.lineMode = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
List<String> options;
|
||||||
|
|
||||||
|
String choose() {
|
||||||
|
int input;
|
||||||
|
int index = 0;
|
||||||
|
|
||||||
|
_renderList(0, initial: true);
|
||||||
|
|
||||||
|
while ((input = _userInput()) != ENTER) {
|
||||||
|
if (input == ARROW_UP) {
|
||||||
|
if (index > 0) {
|
||||||
|
index--;
|
||||||
|
}
|
||||||
|
} else if (input == ARROW_DOWN) {
|
||||||
|
if (index < options.length - 1) {
|
||||||
|
index++;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_renderList(index);
|
||||||
|
}
|
||||||
|
_resetStdin();
|
||||||
|
return options[index];
|
||||||
|
}
|
||||||
|
|
||||||
|
void _deletePreviousList() {
|
||||||
|
for (int i = 0; i < options.length; i++) {
|
||||||
|
Sequences.write(
|
||||||
|
Sequences.escMoveUp(1) + Sequences.escClearLineFromCursorToEnd(),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void _renderList(int index, {bool initial = false}) {
|
||||||
|
if (!initial) {
|
||||||
|
_deletePreviousList();
|
||||||
|
}
|
||||||
|
for (int i = 0; i < options.length; i++) {
|
||||||
|
if (i == index) {
|
||||||
|
stdout.writeln('${Control.rightIndicator()} ${options[i].blue()}');
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
stdout.writeln(' ${options[i]}');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void _resetStdin() {
|
||||||
|
if (stdin.hasTerminal) {
|
||||||
|
// Order is important here
|
||||||
|
stdin.lineMode = true;
|
||||||
|
stdin.echoMode = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO(hpcl): improve keycode parsing for multiple bytes codes
|
||||||
|
int _userInput() {
|
||||||
|
final int navigationResult = stdin.readByteSync();
|
||||||
|
if (navigationResult < 0) {
|
||||||
|
return navigationResult;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Platform.isWindows) {
|
||||||
|
if (navigationResult == Keys.enter) {
|
||||||
|
return ENTER;
|
||||||
|
}
|
||||||
|
if (navigationResult == Keys.space) {
|
||||||
|
return SPACE;
|
||||||
|
}
|
||||||
|
if (navigationResult == Keys.arrowUp[0]) {
|
||||||
|
return ARROW_UP;
|
||||||
|
}
|
||||||
|
if (navigationResult == Keys.arrowDown[0]) {
|
||||||
|
return ARROW_DOWN;
|
||||||
|
} else {
|
||||||
|
return navigationResult;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
if (navigationResult == ENTER) {
|
||||||
|
return ENTER;
|
||||||
|
}
|
||||||
|
if (navigationResult == SPACE) {
|
||||||
|
return SPACE;
|
||||||
|
}
|
||||||
|
|
||||||
|
final int anotherByte = stdin.readByteSync();
|
||||||
|
if (anotherByte == ENTER) {
|
||||||
|
return ENTER;
|
||||||
|
}
|
||||||
|
if (anotherByte == SPACE) {
|
||||||
|
return SPACE;
|
||||||
|
}
|
||||||
|
|
||||||
|
final int input = stdin.readByteSync();
|
||||||
|
return input;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:io';
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/prompt/list_chooser.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/prompt/question.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/stylish/stylish.dart';
|
||||||
|
|
||||||
|
class ListQuestion extends Question<String> {
|
||||||
|
ListQuestion(
|
||||||
|
String question,
|
||||||
|
this.options, {
|
||||||
|
String? comment,
|
||||||
|
required String identifier,
|
||||||
|
}) : super(QuestionType.listQuestion, identifier, question, comment);
|
||||||
|
|
||||||
|
List<String> options;
|
||||||
|
String? answer;
|
||||||
|
|
||||||
|
@override
|
||||||
|
String formatComment() => (super.formatComment().trim().isEmpty)
|
||||||
|
? ' (User arrow keys) '.dim()
|
||||||
|
: super.formatComment();
|
||||||
|
|
||||||
|
@override
|
||||||
|
String ask() {
|
||||||
|
stdout.writeln(formatQuestion());
|
||||||
|
final ListChooser chooser = ListChooser(options);
|
||||||
|
final String input = chooser.choose();
|
||||||
|
answer = input;
|
||||||
|
return input;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:io';
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/prompt/control.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/prompt/question.dart';
|
||||||
|
|
||||||
|
enum MessageLevel { debug, info, success, warn, fail }
|
||||||
|
|
||||||
|
class Message extends Question<void> {
|
||||||
|
Message(
|
||||||
|
String text, {
|
||||||
|
String? comment,
|
||||||
|
this.level = MessageLevel.info,
|
||||||
|
required String identifier,
|
||||||
|
}) : super(QuestionType.message, identifier, text, comment);
|
||||||
|
|
||||||
|
MessageLevel level;
|
||||||
|
|
||||||
|
@override
|
||||||
|
String get prefix {
|
||||||
|
switch (level) {
|
||||||
|
case MessageLevel.debug:
|
||||||
|
return ' ';
|
||||||
|
case MessageLevel.info:
|
||||||
|
return Control.infoIndicator();
|
||||||
|
case MessageLevel.success:
|
||||||
|
return Control.validIndicator();
|
||||||
|
case MessageLevel.warn:
|
||||||
|
return Control.exclamationIndicator();
|
||||||
|
case MessageLevel.fail:
|
||||||
|
return Control.wrongIndicator();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
void ask() {
|
||||||
|
stdout.writeln(formatQuestion());
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,57 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:convert';
|
||||||
|
import 'dart:io';
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/prompt/question.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/sequences/sequences.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/stylish/stylish.dart';
|
||||||
|
|
||||||
|
class NumberQuestion extends Question<num> {
|
||||||
|
NumberQuestion(String question, {String? comment, required String identifier})
|
||||||
|
: super(QuestionType.stringQuestion, identifier, question, comment);
|
||||||
|
|
||||||
|
num? answer;
|
||||||
|
|
||||||
|
@override
|
||||||
|
String formatComment() => (super.formatComment().trim().isEmpty)
|
||||||
|
? ' Mandatory! '.dim()
|
||||||
|
: super.formatComment();
|
||||||
|
|
||||||
|
@override
|
||||||
|
num ask() {
|
||||||
|
stdout.write(formatQuestion());
|
||||||
|
String input = '';
|
||||||
|
bool valid = false;
|
||||||
|
num answer = 0;
|
||||||
|
while (!valid) {
|
||||||
|
input = stdin.readLineSync(encoding: utf8)!.trim();
|
||||||
|
try {
|
||||||
|
valid = input.isNotEmpty;
|
||||||
|
answer = num.parse(input);
|
||||||
|
} catch (e) {
|
||||||
|
valid = false;
|
||||||
|
}
|
||||||
|
stdout.write(Sequences.escMoveUp(1) + formatQuestion());
|
||||||
|
}
|
||||||
|
stdout.writeln(
|
||||||
|
// ignore: lines_longer_than_80_chars
|
||||||
|
'\r${formatQuestion()}${answer.toString().blue()}${Sequences.escClearLineFromCursorToEnd()}',
|
||||||
|
);
|
||||||
|
return answer;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,66 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:convert';
|
||||||
|
import 'dart:io';
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/prompt/keys.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/prompt/question.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/sequences/sequences.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/stylish/stylish.dart';
|
||||||
|
|
||||||
|
class PasswordQuestion extends Question<String> {
|
||||||
|
PasswordQuestion(
|
||||||
|
String question, {
|
||||||
|
String? comment,
|
||||||
|
required String identifier,
|
||||||
|
}) : super(QuestionType.passwordQuestion, identifier, question, comment);
|
||||||
|
|
||||||
|
String? answer;
|
||||||
|
|
||||||
|
@override
|
||||||
|
String ask() {
|
||||||
|
if (stdin.hasTerminal) {
|
||||||
|
stdin.echoMode = false;
|
||||||
|
stdin.lineMode = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
stdout.write(formatQuestion());
|
||||||
|
String input = '';
|
||||||
|
final List<int> bytes = <int>[];
|
||||||
|
|
||||||
|
int lastB = stdin.readByteSync();
|
||||||
|
while (lastB != Keys.enter) {
|
||||||
|
stdout.write('*');
|
||||||
|
bytes.add(lastB);
|
||||||
|
lastB = stdin.readByteSync();
|
||||||
|
}
|
||||||
|
input = utf8.decode(bytes);
|
||||||
|
stdout.write(formatQuestion());
|
||||||
|
answer = List<String>.generate(input.length, (_) => '*')
|
||||||
|
.reduce((String value, String element) => '$value$element');
|
||||||
|
stdout.writeln(
|
||||||
|
// ignore: lines_longer_than_80_chars
|
||||||
|
'\r${formatQuestion()}${answer!.blue()}${Sequences.escClearLineFromCursorToEnd()}',
|
||||||
|
);
|
||||||
|
|
||||||
|
if (stdin.hasTerminal) {
|
||||||
|
stdin.lineMode = true;
|
||||||
|
stdin.echoMode = true;
|
||||||
|
}
|
||||||
|
return input;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,66 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/prompt/question.dart';
|
||||||
|
|
||||||
|
export 'boolean_question.dart';
|
||||||
|
export 'framework/framework.dart';
|
||||||
|
export 'framework/theme.dart';
|
||||||
|
export 'list_question.dart';
|
||||||
|
export 'message.dart';
|
||||||
|
export 'number_question.dart';
|
||||||
|
export 'password_question.dart';
|
||||||
|
export 'question.dart';
|
||||||
|
export 'string_question.dart';
|
||||||
|
export 'widgets/input.dart';
|
||||||
|
|
||||||
|
class Prompt {
|
||||||
|
Prompt({this.questions});
|
||||||
|
|
||||||
|
Map<String, dynamic> answers = <String, dynamic>{};
|
||||||
|
List<Question<dynamic>>? questions;
|
||||||
|
|
||||||
|
void add(Question<dynamic> question) {
|
||||||
|
if (questions != null) {
|
||||||
|
questions!.add(question);
|
||||||
|
} else {
|
||||||
|
questions = <Question<dynamic>>[question];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void addAll(List<Question<dynamic>> questions) {
|
||||||
|
if (this.questions != null) {
|
||||||
|
this.questions!.addAll(questions);
|
||||||
|
} else {
|
||||||
|
this.questions = questions;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Map<String, dynamic> ask() {
|
||||||
|
if (questions != null) {
|
||||||
|
for (final Question<dynamic> question in questions!) {
|
||||||
|
if (!(question.type == QuestionType.message)) {
|
||||||
|
answers[question.identifier] = question.ask();
|
||||||
|
} else {
|
||||||
|
question.ask();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
throw Exception('You must add questions before asking for prompt.');
|
||||||
|
}
|
||||||
|
return answers;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/prompt/control.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/stylish/stylish.dart';
|
||||||
|
|
||||||
|
enum QuestionType {
|
||||||
|
message,
|
||||||
|
stringQuestion,
|
||||||
|
booleanQuestion,
|
||||||
|
listQuestion,
|
||||||
|
passwordQuestion
|
||||||
|
}
|
||||||
|
|
||||||
|
abstract class Question<T> {
|
||||||
|
Question(this.type, this.identifier, this.question, this.comment);
|
||||||
|
|
||||||
|
final QuestionType type;
|
||||||
|
final String identifier;
|
||||||
|
final String question;
|
||||||
|
final String? comment;
|
||||||
|
|
||||||
|
String prefix = Control.questionIndicator();
|
||||||
|
|
||||||
|
String formatComment() => (comment != null) ? ' $comment '.dim() : ' ';
|
||||||
|
String formatQuestion() => '$prefix $question${formatComment()}';
|
||||||
|
|
||||||
|
T ask();
|
||||||
|
}
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:convert';
|
||||||
|
import 'dart:io';
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/prompt/question.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/sequences/sequences.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/stylish/stylish.dart';
|
||||||
|
|
||||||
|
class StringQuestion extends Question<String> {
|
||||||
|
StringQuestion(String question, {String? comment, required String identifier})
|
||||||
|
: super(QuestionType.stringQuestion, identifier, question, comment);
|
||||||
|
|
||||||
|
String? answer;
|
||||||
|
|
||||||
|
@override
|
||||||
|
String ask() {
|
||||||
|
stdout.write(formatQuestion());
|
||||||
|
String input = '';
|
||||||
|
input = stdin.readLineSync(encoding: utf8)!.trim();
|
||||||
|
stdout.write(Sequences.escMoveUp(1) + formatQuestion());
|
||||||
|
answer = input;
|
||||||
|
stdout.writeln(
|
||||||
|
// ignore: lines_longer_than_80_chars
|
||||||
|
'\r${formatQuestion()}${answer!.blue()}${Sequences.escClearLineFromCursorToEnd()}',
|
||||||
|
);
|
||||||
|
return input;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,134 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/prompt/framework/framework.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/prompt/framework/theme.dart';
|
||||||
|
|
||||||
|
class Input extends Widget<String> {
|
||||||
|
final String message;
|
||||||
|
final String initialValue;
|
||||||
|
final String? defaultValue;
|
||||||
|
final bool Function(String)? validator;
|
||||||
|
final Theme theme;
|
||||||
|
|
||||||
|
Input({
|
||||||
|
required this.message,
|
||||||
|
this.initialValue = '',
|
||||||
|
this.defaultValue,
|
||||||
|
this.validator,
|
||||||
|
}) : theme = Theme.defaultTheme;
|
||||||
|
|
||||||
|
Input.withTheme({
|
||||||
|
required this.message,
|
||||||
|
required this.theme,
|
||||||
|
this.initialValue = '',
|
||||||
|
this.defaultValue,
|
||||||
|
this.validator,
|
||||||
|
});
|
||||||
|
|
||||||
|
String promptInput({
|
||||||
|
required String message,
|
||||||
|
String? hint,
|
||||||
|
}) {
|
||||||
|
final buffer = StringBuffer()
|
||||||
|
..write(theme.inputPrefix)
|
||||||
|
..write(theme.messageStyle(message));
|
||||||
|
if (hint != null) {
|
||||||
|
buffer
|
||||||
|
..write(' ')
|
||||||
|
..write(theme.hintStyle(hint));
|
||||||
|
}
|
||||||
|
buffer
|
||||||
|
..write(theme.inputSuffix)
|
||||||
|
..write(' ');
|
||||||
|
return buffer.toString();
|
||||||
|
}
|
||||||
|
|
||||||
|
String promptError({
|
||||||
|
required String message,
|
||||||
|
}) {
|
||||||
|
final buffer = StringBuffer()
|
||||||
|
..write(theme.errorPrefix)
|
||||||
|
..write(theme.errorStyle(message));
|
||||||
|
|
||||||
|
return buffer.toString();
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
State<Input> createState() => _InputState();
|
||||||
|
}
|
||||||
|
|
||||||
|
class _InputState extends State<Input> {
|
||||||
|
String? _value;
|
||||||
|
String? _error;
|
||||||
|
|
||||||
|
@override
|
||||||
|
void initState() {
|
||||||
|
super.initState();
|
||||||
|
_value = widget.initialValue;
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
void dispose() {
|
||||||
|
if (_value != null) {
|
||||||
|
// TODO(hpcl): print success
|
||||||
|
}
|
||||||
|
super.dispose();
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
void build() {
|
||||||
|
if (_error != null) {
|
||||||
|
context.writeln(widget.promptError(message: _error!));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
String prompt() {
|
||||||
|
while (true) {
|
||||||
|
context.write(
|
||||||
|
widget.promptInput(
|
||||||
|
message: widget.message,
|
||||||
|
hint: widget.defaultValue,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
final input = context.readLine(initialValue: widget.initialValue);
|
||||||
|
final line = input.isEmpty && widget.defaultValue != null
|
||||||
|
? widget.defaultValue!
|
||||||
|
: input;
|
||||||
|
if (widget.validator != null) {
|
||||||
|
try {
|
||||||
|
widget.validator!(line);
|
||||||
|
} on ValidationError catch (e) {
|
||||||
|
setState(() {
|
||||||
|
_error = e.message;
|
||||||
|
});
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
setState(() {
|
||||||
|
_value = line;
|
||||||
|
});
|
||||||
|
return _value!;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class ValidationError implements Exception {
|
||||||
|
final String message;
|
||||||
|
|
||||||
|
ValidationError(this.message);
|
||||||
|
}
|
||||||
@@ -0,0 +1,155 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:io';
|
||||||
|
|
||||||
|
/// Abstract class providing some useful ANSI escape sequences
|
||||||
|
abstract class Sequences {
|
||||||
|
/// Clear screen (Raw Sequence) `\x1B[J`
|
||||||
|
static String escClearScreen() => '\x1B[J';
|
||||||
|
|
||||||
|
/// Clear screen from cursor to end (Raw Sequence) `\x1B[0J`
|
||||||
|
static String escClearScreenFromCursorToEnd() => '\x1B[0J';
|
||||||
|
|
||||||
|
/// Clear screen from cursor to start (Raw Sequence) `\x1B[1J`
|
||||||
|
static String escClearScreenFromCursorToStart() => '\x1B[1J';
|
||||||
|
|
||||||
|
/// Clear entire screen (Raw Sequence) `\x1B[2J`
|
||||||
|
static String escClearEntireScreen() => '\x1B[2J';
|
||||||
|
|
||||||
|
/// Clear line (Raw Sequence) `\x1B[K`
|
||||||
|
static String escClearLine() => '\x1B[K';
|
||||||
|
|
||||||
|
/// Clear line from cursor to end (Raw Sequence) `\x1B[0K`
|
||||||
|
static String escClearLineFromCursorToEnd() => '\x1B[0K';
|
||||||
|
|
||||||
|
/// Clear line from cursor to start (Raw Sequence) `\x1B[1K`
|
||||||
|
static String escClearLineFromCursorToStart() => '\x1B[1K';
|
||||||
|
|
||||||
|
/// Clear entire line (Raw Sequence) `\x1B[2K`
|
||||||
|
static String escClearEntireLine() => '\x1B[2K';
|
||||||
|
|
||||||
|
/// Move cursor up **#** lines (Raw Sequence) `\x1B[#A`
|
||||||
|
static String escMoveUp(int n) => '\x1B[${n}A';
|
||||||
|
|
||||||
|
/// Move cursor down **#** lines (Raw Sequence) `\x1B[#B`
|
||||||
|
static String escMoveDown(int n) => '\x1B[${n}B';
|
||||||
|
|
||||||
|
/// Move cursor right **#** columns (Raw Sequence) `\x1B[#C`
|
||||||
|
static String escMoveRight(int n) => '\x1B[${n}C';
|
||||||
|
|
||||||
|
/// Move cursor left **#** columns (Raw Sequence) `\x1B[#D`
|
||||||
|
static String escMoveLeft(int n) => '\x1B[${n}D';
|
||||||
|
|
||||||
|
/// Move cursor down **#** lines and place cursor at start (Raw Sequence) `\x1B[#E`
|
||||||
|
static String escMoveDownAtStart(int n) => '\x1B[${n}E';
|
||||||
|
|
||||||
|
/// Move cursor up **#** lines and place cursor at start (Raw Sequence) `\x1B[#F`
|
||||||
|
static String escMoveUpAtStart(int n) => '\x1B[${n}F';
|
||||||
|
|
||||||
|
/// Move cursor on x axis **#** columens (Raw Sequence) `\x1B[#G`
|
||||||
|
static String escMoveHorizontal(int n) => '\x1B[${n}G';
|
||||||
|
|
||||||
|
/// Move cursor on x,y axis (Raw Sequence) `\x1B[$line;${column}H`
|
||||||
|
static String escMoveCursor(int line, int column) => '\x1B[$line;${column}H';
|
||||||
|
|
||||||
|
/// Save cursor position (Raw Sequence) `\x1B7`
|
||||||
|
static String escSavePosition() => '\x1B7';
|
||||||
|
|
||||||
|
/// Restore cursor position (Raw Sequence) `\x1B8`
|
||||||
|
static String escRestorePosition() => '\x1B8';
|
||||||
|
|
||||||
|
/// Hide cursor (Raw Sequence) `\x1B[?25l`
|
||||||
|
static String escHideCursor() => '\x1B[?25l';
|
||||||
|
|
||||||
|
/// Unhide cursor (Raw Sequence) `\x1B[?25h`
|
||||||
|
static String escUnhideCursor() => '\x1B[?25h';
|
||||||
|
|
||||||
|
/// Clear screen `\x1B[J`
|
||||||
|
static void clearScreen() => write(escClearScreen());
|
||||||
|
|
||||||
|
/// Clear screen from cursor to end `\x1B[0J`
|
||||||
|
static void clearScreenFromCursorToEnd() =>
|
||||||
|
write(escClearScreenFromCursorToEnd());
|
||||||
|
|
||||||
|
/// Clear screen from cursor to start `\x1B[1J`
|
||||||
|
static void clearScreenFromCursorToStart() =>
|
||||||
|
write(escClearScreenFromCursorToStart());
|
||||||
|
|
||||||
|
/// Clear entire screen `\x1B[2J`
|
||||||
|
static void clearEntireScreen() => write(escClearEntireScreen());
|
||||||
|
|
||||||
|
/// Clear line `\x1B[K`
|
||||||
|
static void clearLine() => write(escClearLine());
|
||||||
|
|
||||||
|
/// Clear line from cursor to end `\x1B[0K`
|
||||||
|
static void clearLineFromCursorToEnd() =>
|
||||||
|
write(escClearLineFromCursorToEnd());
|
||||||
|
|
||||||
|
/// Clear line from cursor to start `\x1B[1K`
|
||||||
|
static void clearLineFromCursorToStart() =>
|
||||||
|
write(escClearLineFromCursorToStart());
|
||||||
|
|
||||||
|
/// Clear entire line `\x1B[2K`
|
||||||
|
static void clearEntireLine() => write(escClearEntireLine());
|
||||||
|
|
||||||
|
/// Move cursor up **#** lines `\x1B[#A`
|
||||||
|
static void moveUp(int n) => write(escMoveUp(n));
|
||||||
|
|
||||||
|
/// Move cursor down **#** lines `\x1B[#B`
|
||||||
|
static void moveDown(int n) => write(escMoveDown(n));
|
||||||
|
|
||||||
|
/// Move cursor right **#** columns `\x1B[#C`
|
||||||
|
static void moveRight(int n) => write(escMoveRight(n));
|
||||||
|
|
||||||
|
/// Move cursor left **#** columns `\x1B[#D`
|
||||||
|
static void moveLeft(int n) => write(escMoveLeft(n));
|
||||||
|
|
||||||
|
/// Move cursor down **#** lines and place cursor at start `\x1B[#E`
|
||||||
|
static void moveDownAtStart(int n) => write(escMoveDownAtStart(n));
|
||||||
|
|
||||||
|
/// Move cursor up **#** lines and place cursor at start `\x1B[#F`
|
||||||
|
static void moveUpAtStart(int n) => write(escMoveUpAtStart(n));
|
||||||
|
|
||||||
|
/// Move cursor on x axis **#** columens `\x1B[#G`
|
||||||
|
static void moveHorizontal(int n) => write(escMoveHorizontal(n));
|
||||||
|
|
||||||
|
/// Move cursor on x,y axis `\x1B[$line;${column}H`
|
||||||
|
static void moveCursor(int line, int column) =>
|
||||||
|
write(escMoveCursor(line, column));
|
||||||
|
|
||||||
|
/// Save cursor position `\x1B7`
|
||||||
|
static void savePosition() => write(escSavePosition());
|
||||||
|
|
||||||
|
/// Restore cursor position `\x1B8`
|
||||||
|
static void restorePosition() => write(escRestorePosition());
|
||||||
|
|
||||||
|
/// Hide cursor `\x1B[?25l`
|
||||||
|
static void hideCursor() => write(escHideCursor());
|
||||||
|
|
||||||
|
/// Unhide cursor `\x1B[?25h`
|
||||||
|
static void unhideCursor() => write(escUnhideCursor());
|
||||||
|
|
||||||
|
/// Write string in standard output
|
||||||
|
static void write(String string) {
|
||||||
|
stdout.write(string);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Write string on new line in standard output
|
||||||
|
static void writeln(String string) {
|
||||||
|
stdout.writeln(string);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,99 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:async';
|
||||||
|
import 'dart:io';
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/sequences/sequences.dart';
|
||||||
|
|
||||||
|
/// The [frames] field holds each individual frame of an animation, whilst the
|
||||||
|
/// [interval] represents the sleep time between each frame.
|
||||||
|
class Indicator {
|
||||||
|
|
||||||
|
Indicator({
|
||||||
|
required this.name,
|
||||||
|
required this.interval,
|
||||||
|
required this.frames,
|
||||||
|
this.label,
|
||||||
|
});
|
||||||
|
|
||||||
|
factory Indicator.fromMap(Map<String, Map<String, Object>> map) {
|
||||||
|
final String name = map.keys.first;
|
||||||
|
return Indicator(
|
||||||
|
name: name,
|
||||||
|
// ignore: cast_nullable_to_non_nullable
|
||||||
|
interval: map[name]!['interval'] as int,
|
||||||
|
// ignore: cast_nullable_to_non_nullable
|
||||||
|
frames: List<String>.from(map[name]!['frames'] as List<String>),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
final String name;
|
||||||
|
final int interval;
|
||||||
|
final List<String> frames;
|
||||||
|
final String? label;
|
||||||
|
Timer? _timer;
|
||||||
|
|
||||||
|
|
||||||
|
Map<String, Map<String, Object>> toMap() {
|
||||||
|
return <String, Map<String, Object>>{
|
||||||
|
name: <String, Object>{
|
||||||
|
'interval': interval,
|
||||||
|
'frames': frames,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Animate the spinner.
|
||||||
|
void animate() {
|
||||||
|
stop();
|
||||||
|
int frame = 0;
|
||||||
|
_timer = Timer.periodic(Duration(milliseconds: interval), (Timer t) {
|
||||||
|
Sequences.clearEntireLine();
|
||||||
|
frame = (frame + 1) % frames.length;
|
||||||
|
if (label != null) {
|
||||||
|
stdout.write('${frames[frame]} $label');
|
||||||
|
} else {
|
||||||
|
stdout.write(frames[frame]);
|
||||||
|
}
|
||||||
|
Sequences.moveHorizontal(1);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Stop the spinner (but don't kill isolate)
|
||||||
|
void stop() {
|
||||||
|
Sequences.clearEntireLine();
|
||||||
|
_timer?.cancel();
|
||||||
|
}
|
||||||
|
|
||||||
|
Indicator copyWith({
|
||||||
|
String? name,
|
||||||
|
int? interval,
|
||||||
|
List<String>? frames,
|
||||||
|
String? label,
|
||||||
|
}) {
|
||||||
|
return Indicator(
|
||||||
|
name: name ?? this.name,
|
||||||
|
interval: interval ?? this.interval,
|
||||||
|
frames: frames ?? this.frames,
|
||||||
|
label: label ?? this.label,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
@override
|
||||||
|
String toString() =>
|
||||||
|
'Indicator(name: $name, interval: $interval, frames: $frames)';
|
||||||
|
}
|
||||||
@@ -0,0 +1,66 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:async';
|
||||||
|
import 'dart:isolate';
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/sequences/sequences.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/spinners/indicator.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/spinners/spinner_type.dart';
|
||||||
|
|
||||||
|
|
||||||
|
class Spinner {
|
||||||
|
/// Active isolate object. Is created when [start] is called.
|
||||||
|
static Isolate? _spinnerIsolate;
|
||||||
|
|
||||||
|
/// Run the animation of active [_spinnerIsolate].
|
||||||
|
static Future<void> _animate(Indicator indicator) async {
|
||||||
|
indicator.animate();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Starts an animation on a new line.
|
||||||
|
static Future<Isolate> start(SpinnerType spinner, {String? text}) async {
|
||||||
|
return custom(spinner.indicator.copyWith(label: text));
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Starts a custom animation on a new line.
|
||||||
|
static Future<Isolate> custom(Indicator indicator) async {
|
||||||
|
Sequences.hideCursor();
|
||||||
|
return _spinnerIsolate ??
|
||||||
|
(_spinnerIsolate = await Isolate.spawn(
|
||||||
|
_animate,
|
||||||
|
indicator,
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Stops current spinner animation by killing the isolate instance,
|
||||||
|
/// and clears current line.
|
||||||
|
static void stop() {
|
||||||
|
if (_spinnerIsolate != null) {
|
||||||
|
_spinnerIsolate!.kill(priority: Isolate.immediate);
|
||||||
|
}
|
||||||
|
_spinnerIsolate = null;
|
||||||
|
Sequences.clearEntireLine();
|
||||||
|
Sequences.moveHorizontal(1);
|
||||||
|
Sequences.unhideCursor();
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Stop and restart a new indicator on same line.
|
||||||
|
static void update(Indicator indicator) {
|
||||||
|
stop();
|
||||||
|
custom(indicator);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,113 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/spinners/spinners.dart';
|
||||||
|
|
||||||
|
enum SpinnerType {
|
||||||
|
dots,
|
||||||
|
dots2,
|
||||||
|
dots3,
|
||||||
|
dots4,
|
||||||
|
dots5,
|
||||||
|
dots6,
|
||||||
|
dots7,
|
||||||
|
dots8,
|
||||||
|
dots9,
|
||||||
|
dots10,
|
||||||
|
dots11,
|
||||||
|
dots12,
|
||||||
|
dots8Bit,
|
||||||
|
line,
|
||||||
|
line2,
|
||||||
|
pipe,
|
||||||
|
simpleDots,
|
||||||
|
simpleDotsScrolling,
|
||||||
|
star,
|
||||||
|
star2,
|
||||||
|
flip,
|
||||||
|
hamburger,
|
||||||
|
growVertical,
|
||||||
|
growHorizontal,
|
||||||
|
balloon,
|
||||||
|
balloon2,
|
||||||
|
noise,
|
||||||
|
bounce,
|
||||||
|
boxBounce,
|
||||||
|
boxBounce2,
|
||||||
|
triangle,
|
||||||
|
arc,
|
||||||
|
circle,
|
||||||
|
squareCorners,
|
||||||
|
circleQuarters,
|
||||||
|
circleHalves,
|
||||||
|
squish,
|
||||||
|
toggle,
|
||||||
|
toggle2,
|
||||||
|
toggle3,
|
||||||
|
toggle4,
|
||||||
|
toggle5,
|
||||||
|
toggle6,
|
||||||
|
toggle7,
|
||||||
|
toggle8,
|
||||||
|
toggle9,
|
||||||
|
toggle10,
|
||||||
|
toggle11,
|
||||||
|
toggle12,
|
||||||
|
toggle13,
|
||||||
|
arrow,
|
||||||
|
arrow2,
|
||||||
|
arrow3,
|
||||||
|
bouncingBar,
|
||||||
|
bouncingBall,
|
||||||
|
smiley,
|
||||||
|
monkey,
|
||||||
|
hearts,
|
||||||
|
clock,
|
||||||
|
earth,
|
||||||
|
material,
|
||||||
|
moon,
|
||||||
|
runner,
|
||||||
|
pong,
|
||||||
|
shark,
|
||||||
|
dqpb,
|
||||||
|
weather,
|
||||||
|
christmas,
|
||||||
|
grenade,
|
||||||
|
point,
|
||||||
|
layer,
|
||||||
|
betaWave,
|
||||||
|
fingerDance,
|
||||||
|
fistBump,
|
||||||
|
soccerHeader,
|
||||||
|
mindblown,
|
||||||
|
speaker,
|
||||||
|
orangePulse,
|
||||||
|
bluePulse,
|
||||||
|
orangeBluePulse,
|
||||||
|
timeTravel,
|
||||||
|
aesthetic;
|
||||||
|
|
||||||
|
String get name => toString().replaceAll(RegExp('SpinnerType.'), '');
|
||||||
|
Indicator get indicator {
|
||||||
|
if (spinners.keys.contains(name)) {
|
||||||
|
return Indicator.fromMap(
|
||||||
|
<String, Map<String, Object>>{name: spinners[name]!},
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
throw UnimplementedError();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,210 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/stylish/utils.dart';
|
||||||
|
|
||||||
|
extension Stylish on String {
|
||||||
|
/// Status of the extension
|
||||||
|
static bool enabled = true;
|
||||||
|
|
||||||
|
/// Formats a string if ansi escape sequences are supported.
|
||||||
|
static bool forced = false;
|
||||||
|
|
||||||
|
/// Enable or disable styling
|
||||||
|
static void config({bool? enable}) {
|
||||||
|
Stylish.enabled = enable ?? Stylish.enabled;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Foreground Colors
|
||||||
|
/// Format this string with ANSI to be colored black.
|
||||||
|
String black() => format(30, 39)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored red.
|
||||||
|
String red() => format(31, 39)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored green.
|
||||||
|
String green() => format(32, 39)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored yellow.
|
||||||
|
String yellow() => format(33, 39)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored blue.
|
||||||
|
String blue() => format(34, 39)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored magenta.
|
||||||
|
String magenta() => format(35, 39)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored cyan.
|
||||||
|
String cyan() => format(36, 39)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored white.
|
||||||
|
String white() => format(37, 39)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored bright black or gray or grey.
|
||||||
|
String brightBlack() => format(90, 39)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored bright red.
|
||||||
|
String brightRed() => format(91, 39)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored bright green.
|
||||||
|
String brightGreen() => format(92, 39)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored bright yellow.
|
||||||
|
String brightYellow() => format(93, 39)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored bright blue.
|
||||||
|
String brightBlue() => format(94, 39)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored bright magenta.
|
||||||
|
String brightMagenta() => format(95, 39)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored bright cyan.
|
||||||
|
String brightCyan() => format(96, 39)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored bright white.
|
||||||
|
String brightWhite() => format(97, 39)(this);
|
||||||
|
|
||||||
|
// Background Colors
|
||||||
|
/// Format this string with ANSI adding a black background color.
|
||||||
|
String bgBlack() => format(40, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a red background color.
|
||||||
|
String bgRed() => format(41, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a green background color.
|
||||||
|
String bgGreen() => format(42, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a yellow background color.
|
||||||
|
String bgYellow() => format(43, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a blue background color.
|
||||||
|
String bgBlue() => format(44, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a magenta background color.
|
||||||
|
String bgMagenta() => format(45, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a cyan background color.
|
||||||
|
String bgCyan() => format(46, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a white background color.
|
||||||
|
String bgWhite() => format(47, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a bright black
|
||||||
|
/// or gray or grey background color.
|
||||||
|
String bgBrightBlack() => format(100, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a bright red
|
||||||
|
/// background color.
|
||||||
|
String bgBrightRed() => format(101, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a bright green
|
||||||
|
/// background color.
|
||||||
|
String bgBrightGreen() => format(102, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a bright yellow
|
||||||
|
/// background color.
|
||||||
|
String bgBrightYellow() => format(103, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a bright blue
|
||||||
|
/// background color.
|
||||||
|
String bgBrightBlue() => format(104, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a bright magenta
|
||||||
|
/// background color.
|
||||||
|
String bgBrightMagenta() => format(105, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a bright cyan
|
||||||
|
/// background color.
|
||||||
|
String bgBrightCyan() => format(106, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a bright white
|
||||||
|
/// background color.
|
||||||
|
String bgBrightWhite() => format(107, 49)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored bright black or gray or grey.
|
||||||
|
String gray() => brightBlack();
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be colored bright black or gray or grey.
|
||||||
|
String grey() => brightBlack();
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a bright black
|
||||||
|
/// or gray or grey background color.
|
||||||
|
String bgGray() => bgBrightBlack();
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a bright black
|
||||||
|
/// or gray or grey background color.
|
||||||
|
String bgGrey() => bgBrightBlack();
|
||||||
|
|
||||||
|
/// Format this string with ANSI to be styled as a bold text.
|
||||||
|
String bold() => format(1, 22)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to make it appear as a dimmed text.
|
||||||
|
String dim() => format(2, 22)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI to make it appear italic.
|
||||||
|
String italic() => format(3, 23)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding an underline.
|
||||||
|
String underline() => format(4, 24)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI making it appear blinking slowly.
|
||||||
|
String blink() => format(5, 25)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI making it appear blinking rapidly.
|
||||||
|
String strobe() => format(6, 25)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI inverting the style.
|
||||||
|
String inverse() => format(7, 27)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI making it invisible.
|
||||||
|
String hidden() => format(8, 28)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a strike through the text.
|
||||||
|
String strikethrough() => format(9, 29)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a frame.
|
||||||
|
String frame() => format(51, 54)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding a circle.
|
||||||
|
String encircle() => format(52, 54)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI adding an overline.
|
||||||
|
String overline() => format(53, 55)(this);
|
||||||
|
|
||||||
|
/// Format this string with ANSI resetting the previous color chains.
|
||||||
|
String reset() => format(0, 0)(this);
|
||||||
|
|
||||||
|
/// If exists, all ANSI sequences will be removed from this string.
|
||||||
|
String strip() {
|
||||||
|
return replaceAll(ansiPattern, '');
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Format this string with ANSI setting it's foreground color the
|
||||||
|
/// value defined as RGB parameters.
|
||||||
|
///
|
||||||
|
/// [r]/[g]/[b] parameters can be an [int] in the range of `0` to `255`.
|
||||||
|
String fg({int r = 255, int g = 255, int b = 255}) {
|
||||||
|
return format('38;5;${rgbToAnsiCode(r, g, b)}', 0)(this);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Format this string with ANSI setting it's background color the value
|
||||||
|
/// defined as RGB parameters.
|
||||||
|
///
|
||||||
|
/// [r]/[g]/[b] parameters can be an [int] in the range of `0` to `255`.
|
||||||
|
String bg({int r = 255, int g = 255, int b = 255}) {
|
||||||
|
return format('48;5;${rgbToAnsiCode(r, g, b)}', 0)(this);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
bool get supportsAnsiColor => false;
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
bool get supportsAnsiColor => true;
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:io';
|
||||||
|
|
||||||
|
bool get supportsAnsiColor => stdout.supportsAnsiEscapes;
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/stylish/stylish.dart';
|
||||||
|
|
||||||
|
/// Converts an rgb value of given [r], [g] and [b] int values
|
||||||
|
/// to an ANSI usable color.
|
||||||
|
int rgbToAnsiCode(int r, int g, int b) =>
|
||||||
|
(((r.clamp(0, 255) / 255) * 5).toInt() * 36 +
|
||||||
|
((g.clamp(0, 255) / 255) * 5).toInt() * 6 +
|
||||||
|
((b.clamp(0, 255) / 255) * 5).toInt() +
|
||||||
|
16)
|
||||||
|
.clamp(0, 256);
|
||||||
|
|
||||||
|
/// Regular Expression pattern for all possible types of ANSI escape
|
||||||
|
/// sequences in a [String].
|
||||||
|
final RegExp ansiPattern = RegExp(
|
||||||
|
<String>[
|
||||||
|
r'[\u001B\u009B][[\]()#;?]*(?:(?:(?:[a-zA-Z\d]*(?:;[-a-zA-Z\d\/#&.:=?%@~_]*)*)?\u0007)',
|
||||||
|
r'(?:(?:\d{1,4}(?:;\d{0,4})*)?[\dA-PR-TZcf-ntqry=><~]))'
|
||||||
|
].join('|'),
|
||||||
|
);
|
||||||
|
|
||||||
|
/// Formats a string if ansi escape sequences are supported.
|
||||||
|
String Function(String) format(dynamic start, dynamic end) => (String x) {
|
||||||
|
// if ((supportsAnsiColor || Stylish.forced) && Stylish.enabled) {
|
||||||
|
if (Stylish.enabled) {
|
||||||
|
return '\x1B[${start}m$x\x1B[${end}m';
|
||||||
|
} else {
|
||||||
|
return x;
|
||||||
|
}
|
||||||
|
};
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
class SkipException implements Exception {
|
||||||
|
SkipException(this.message);
|
||||||
|
|
||||||
|
final String? message;
|
||||||
|
|
||||||
|
@override
|
||||||
|
String toString() {
|
||||||
|
final Object? message = this.message;
|
||||||
|
if (message == null) return 'Skipped';
|
||||||
|
return '$message';
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,148 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:async';
|
||||||
|
import 'dart:io';
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/sequences/sequences.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/spinners/spinners.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/stylish/stylish.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/workflow/skip_exception.dart';
|
||||||
|
|
||||||
|
enum ExitStatus { nil, success, fail, skip }
|
||||||
|
|
||||||
|
class Task<T> {
|
||||||
|
Task({
|
||||||
|
required this.name,
|
||||||
|
String? id,
|
||||||
|
SpinnerType? spinner,
|
||||||
|
this.timer = true,
|
||||||
|
this.task,
|
||||||
|
this.onFinish,
|
||||||
|
this.onError,
|
||||||
|
this.onSkip,
|
||||||
|
}) {
|
||||||
|
if (id != null) {
|
||||||
|
identifier = id;
|
||||||
|
} else {
|
||||||
|
identifier = name;
|
||||||
|
}
|
||||||
|
_isolateTask = IsolateTask(
|
||||||
|
name: name,
|
||||||
|
spinner: spinner ?? SpinnerType.dots,
|
||||||
|
timer: timer,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
String name;
|
||||||
|
late String identifier;
|
||||||
|
bool timer;
|
||||||
|
|
||||||
|
/// **Synchronous** function. Use experimental `waitFor()`
|
||||||
|
/// if you have async calls.**
|
||||||
|
T Function()? task;
|
||||||
|
T? result;
|
||||||
|
|
||||||
|
String Function(Object? o)? onFinish;
|
||||||
|
String Function(Object e)? onError;
|
||||||
|
String Function(SkipException e)? onSkip;
|
||||||
|
|
||||||
|
late IsolateTask _isolateTask;
|
||||||
|
static String lastPrint = '';
|
||||||
|
|
||||||
|
IsolateTask get animation => _isolateTask;
|
||||||
|
|
||||||
|
T? invoke() {
|
||||||
|
final T Function()? t = task;
|
||||||
|
if (t != null) {
|
||||||
|
return t();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
static void print(String message) {
|
||||||
|
//waitFor(Future<void>.delayed(Duration(milliseconds: 1)));
|
||||||
|
lastPrint = message;
|
||||||
|
stdout.write('\n');
|
||||||
|
Sequences.moveDownAtStart(1);
|
||||||
|
Sequences.clearEntireLine();
|
||||||
|
stdout.write(' > $message'.dim());
|
||||||
|
Sequences.moveUpAtStart(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
static void clearPrint() {
|
||||||
|
Sequences.moveDownAtStart(1);
|
||||||
|
Sequences.clearEntireLine();
|
||||||
|
Sequences.moveUpAtStart(1);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class IsolateTask {
|
||||||
|
IsolateTask({
|
||||||
|
required this.name,
|
||||||
|
required SpinnerType spinner,
|
||||||
|
required this.timer,
|
||||||
|
}) {
|
||||||
|
_indicator = spinner.indicator;
|
||||||
|
}
|
||||||
|
|
||||||
|
final Stopwatch _stopwatch = Stopwatch();
|
||||||
|
Timer? _timer;
|
||||||
|
int _frame = 0;
|
||||||
|
late Indicator _indicator;
|
||||||
|
|
||||||
|
String name;
|
||||||
|
bool timer;
|
||||||
|
|
||||||
|
void run() {
|
||||||
|
if (timer) {
|
||||||
|
_stopwatch
|
||||||
|
..reset()
|
||||||
|
..start();
|
||||||
|
_timer?.cancel();
|
||||||
|
}
|
||||||
|
|
||||||
|
_timer = Timer.periodic(
|
||||||
|
Duration(milliseconds: _indicator.interval),
|
||||||
|
(Timer t) {
|
||||||
|
Sequences.clearEntireLine();
|
||||||
|
_frame = (_frame + 1) % _indicator.frames.length;
|
||||||
|
stdout.write('${_indicator.frames[_frame].green()} $name...');
|
||||||
|
Sequences.moveHorizontal(1);
|
||||||
|
},
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
void stop(ExitStatus status, {String? reason}) {
|
||||||
|
_stopwatch.stop();
|
||||||
|
final String time =
|
||||||
|
(_stopwatch.elapsed.inMilliseconds / 1000.0).toStringAsFixed(1);
|
||||||
|
Sequences.clearEntireLine();
|
||||||
|
String prefix = '';
|
||||||
|
String message = '';
|
||||||
|
if (status == ExitStatus.success) {
|
||||||
|
prefix = '✓'.green();
|
||||||
|
message = reason ?? 'Finished';
|
||||||
|
} else if (status == ExitStatus.fail) {
|
||||||
|
prefix = 'x'.red();
|
||||||
|
message = reason ?? 'Failed';
|
||||||
|
} else if (status == ExitStatus.skip) {
|
||||||
|
prefix = '◊'.yellow();
|
||||||
|
message = reason ?? 'Skipped';
|
||||||
|
}
|
||||||
|
stdout.write('$prefix $message ${timer ? '(${time}s)' : ''}\n');
|
||||||
|
_timer?.cancel();
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:async';
|
||||||
|
|
||||||
|
// From dart-cli
|
||||||
|
T waitFor<T>(Future<T> future, {Duration? timeout}) {
|
||||||
|
late T result;
|
||||||
|
bool futureCompleted = false;
|
||||||
|
Object? error;
|
||||||
|
StackTrace? stacktrace;
|
||||||
|
|
||||||
|
future.then(
|
||||||
|
(T r) {
|
||||||
|
futureCompleted = true;
|
||||||
|
result = r;
|
||||||
|
},
|
||||||
|
onError: (Object? e, StackTrace? st) {
|
||||||
|
error = e;
|
||||||
|
stacktrace = st;
|
||||||
|
},
|
||||||
|
);
|
||||||
|
|
||||||
|
late Stopwatch s;
|
||||||
|
if (timeout != null) {
|
||||||
|
s = Stopwatch()..start();
|
||||||
|
}
|
||||||
|
|
||||||
|
Timer.run(() {});
|
||||||
|
|
||||||
|
while (!futureCompleted && (error == null)) {
|
||||||
|
Duration? remaining;
|
||||||
|
if (timeout != null) {
|
||||||
|
if (s.elapsed >= timeout) {
|
||||||
|
throw TimeoutException('waitFor() timed out', timeout);
|
||||||
|
}
|
||||||
|
remaining = timeout - s.elapsed;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (timeout != null) {
|
||||||
|
s.stop();
|
||||||
|
}
|
||||||
|
|
||||||
|
Timer.run(() {});
|
||||||
|
|
||||||
|
if (error != null) {
|
||||||
|
throw AsyncError(error!, stacktrace);
|
||||||
|
}
|
||||||
|
|
||||||
|
return result;
|
||||||
|
}
|
||||||
@@ -0,0 +1,164 @@
|
|||||||
|
// Copyright (C) 2022 WYATT GROUP
|
||||||
|
// Please see the AUTHORS file for details.
|
||||||
|
//
|
||||||
|
// This program is free software: you can redistribute it and/or modify
|
||||||
|
// it under the terms of the GNU General Public License as published by
|
||||||
|
// the Free Software Foundation, either version 3 of the License, or
|
||||||
|
// any later version.
|
||||||
|
//
|
||||||
|
// This program is distributed in the hope that it will be useful,
|
||||||
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
// GNU General Public License for more details.
|
||||||
|
//
|
||||||
|
// You should have received a copy of the GNU General Public License
|
||||||
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
import 'dart:async';
|
||||||
|
import 'dart:isolate';
|
||||||
|
|
||||||
|
import 'package:wyatt_cli_toolbox/src/sequences/sequences.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/workflow/skip_exception.dart';
|
||||||
|
import 'package:wyatt_cli_toolbox/src/workflow/task.dart';
|
||||||
|
|
||||||
|
export 'skip_exception.dart';
|
||||||
|
export 'task.dart';
|
||||||
|
export 'utils.dart';
|
||||||
|
|
||||||
|
enum WorkflowControl { start, next, stop }
|
||||||
|
|
||||||
|
class Workflow {
|
||||||
|
Workflow._(this._workflowIsolate, this._tasks, this._toIsolate);
|
||||||
|
|
||||||
|
Isolate? _workflowIsolate;
|
||||||
|
final SendPort _toIsolate;
|
||||||
|
final List<Task<dynamic>> _tasks;
|
||||||
|
final Map<String, dynamic> _results = <String, dynamic>{};
|
||||||
|
|
||||||
|
Map<String, dynamic> get results => _results;
|
||||||
|
|
||||||
|
static Future<Workflow> _initIsolate(List<Task<dynamic>> tasks) async {
|
||||||
|
final List<IsolateTask> animations = <IsolateTask>[];
|
||||||
|
for (final Task<dynamic> t in tasks) {
|
||||||
|
animations.add(t.animation);
|
||||||
|
}
|
||||||
|
|
||||||
|
Isolate? workflowIsolate;
|
||||||
|
|
||||||
|
final Completer<Workflow> completer = Completer<Workflow>();
|
||||||
|
final ReceivePort isolateToMainStream = ReceivePort()
|
||||||
|
// Retrieve send port sent by isolate
|
||||||
|
..listen((dynamic data) {
|
||||||
|
if (data is SendPort) {
|
||||||
|
completer.complete(Workflow._(workflowIsolate, tasks, data));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
workflowIsolate = await Isolate.spawn(
|
||||||
|
_start,
|
||||||
|
<Object>[isolateToMainStream.sendPort, animations],
|
||||||
|
);
|
||||||
|
return completer.future;
|
||||||
|
}
|
||||||
|
|
||||||
|
static void _start(List<Object?> args) {
|
||||||
|
// ignore: cast_nullable_to_non_nullable
|
||||||
|
final SendPort isolateToMainStream = args[0] as SendPort;
|
||||||
|
// ignore: cast_nullable_to_non_nullable
|
||||||
|
final List<IsolateTask> tasks = args[1] as List<IsolateTask>;
|
||||||
|
final ReceivePort mainToIsolateStream = ReceivePort();
|
||||||
|
|
||||||
|
isolateToMainStream.send(mainToIsolateStream.sendPort);
|
||||||
|
|
||||||
|
mainToIsolateStream.listen((dynamic data) {
|
||||||
|
final List<Object?> args = data as List<Object?>;
|
||||||
|
// ignore: cast_nullable_to_non_nullable
|
||||||
|
final WorkflowControl control = args[0] as WorkflowControl;
|
||||||
|
// ignore: cast_nullable_to_non_nullable
|
||||||
|
final int taskId = args[1] as int;
|
||||||
|
final ExitStatus? exit = args[2] as ExitStatus?;
|
||||||
|
final String? reason = args[3] as String?;
|
||||||
|
|
||||||
|
if (control == WorkflowControl.start) {
|
||||||
|
tasks[taskId].run();
|
||||||
|
} else if (control == WorkflowControl.next) {
|
||||||
|
if (exit != null) {
|
||||||
|
tasks[taskId - 1].stop(exit, reason: reason);
|
||||||
|
}
|
||||||
|
tasks[taskId].run();
|
||||||
|
} else if (control == WorkflowControl.stop) {
|
||||||
|
tasks[taskId].stop(exit!, reason: reason);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
static Future<Workflow> create(List<Task<dynamic>> tasks) async {
|
||||||
|
final Workflow w = await _initIsolate(tasks);
|
||||||
|
return w;
|
||||||
|
}
|
||||||
|
|
||||||
|
void _animation(
|
||||||
|
WorkflowControl control,
|
||||||
|
int taskId, {
|
||||||
|
ExitStatus? status,
|
||||||
|
String? reason,
|
||||||
|
}) {
|
||||||
|
_toIsolate.send(<Object?>[control, taskId, status, reason]);
|
||||||
|
}
|
||||||
|
|
||||||
|
Map<String, dynamic> start() {
|
||||||
|
Sequences.hideCursor();
|
||||||
|
int _index = 0;
|
||||||
|
|
||||||
|
for (final Task<dynamic> _ in _tasks) {
|
||||||
|
_call(_index);
|
||||||
|
_index++;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (_workflowIsolate != null) {
|
||||||
|
_workflowIsolate!.kill(priority: Isolate.immediate);
|
||||||
|
}
|
||||||
|
_workflowIsolate = null;
|
||||||
|
Sequences.unhideCursor();
|
||||||
|
return _results;
|
||||||
|
}
|
||||||
|
|
||||||
|
ExitStatus _call(int taskId) {
|
||||||
|
ExitStatus status = ExitStatus.nil;
|
||||||
|
String message = 'nil';
|
||||||
|
final Task<dynamic> t = _tasks[taskId];
|
||||||
|
|
||||||
|
if (t.task != null) {
|
||||||
|
_animation(WorkflowControl.start, taskId);
|
||||||
|
try {
|
||||||
|
// Call task function
|
||||||
|
final dynamic res = t.invoke();
|
||||||
|
_results[t.identifier] = res;
|
||||||
|
|
||||||
|
message = 'Finished';
|
||||||
|
if (t.onFinish != null) {
|
||||||
|
message = t.onFinish!(res);
|
||||||
|
}
|
||||||
|
status = ExitStatus.success;
|
||||||
|
} catch (e) {
|
||||||
|
if (e is SkipException) {
|
||||||
|
message = e.toString();
|
||||||
|
if (t.onSkip != null) {
|
||||||
|
message = t.onSkip!(e);
|
||||||
|
}
|
||||||
|
|
||||||
|
status = ExitStatus.skip;
|
||||||
|
} else {
|
||||||
|
message = e.toString();
|
||||||
|
if (t.onError != null) {
|
||||||
|
message = t.onError!(e);
|
||||||
|
}
|
||||||
|
|
||||||
|
status = ExitStatus.fail;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
_animation(WorkflowControl.stop, taskId, status: status, reason: message);
|
||||||
|
}
|
||||||
|
return status;
|
||||||
|
}
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user