linksplatform / interfaces

LinksPlatform's Platform.Interfaces Class Library

		C++
		C#

Interfaces

LinksPlatform's Platform.Interfaces Class Library

Contains common interfaces that did not fit in any major category.

Namespace: Platform.Interfaces

Forked from: Konard/LinksPlatform/Platform/Platform.Helpers

NuGet package: Platform.Interfaces

Documentation

• Interface IFactory<TProduct>.

PDF file with code for e-readers.

Dependent libraries

• Platform.Collections
• Platform.Setters
• Platform.Timestamps

interfaces's Issues

Do we need to drop lists of dependent libraries and dependencies in README?

Looks like these are duplicates of:
https://github.com/linksplatform/Interfaces/network/dependencies
https://github.com/linksplatform/Interfaces/network/dependents

The package has no published symbols yet

Do we really need to delete projects?

Interfaces/.github/workflows/CD.yml

Lines 21 to 24 in cfd19b1

	- name: Remove Cpp projects
	run: |
	export REPOSITORY_NAME=$(basename ${{ github.repository }})
	dotnet sln "Platform.$REPOSITORY_NAME.sln" remove cpp/Platform.$REPOSITORY_NAME.Tests/Platform.$REPOSITORY_NAME.TemplateLibrary.Tests.vcxproj

Interfaces/.github/workflows/CD.yml

Lines 70 to 72 in cfd19b1

	- name: Remove Cpp projects
	run: |
	dotnet sln "Platform.Interfaces.sln" remove cpp/Platform.Interfaces.Tests/Platform.Interfaces.TemplateLibrary.Tests.vcxproj

Looks like in the https://github.com/linksplatform/Exceptions repository it works without removal of projects.
If the change is required it should be applied to all repositories of LinksPlatform.

Should we remove word Operator from IPropertiesOperator and IPropertyOperator interfaces?

Publish NuGet package to GitHub Registry from linux

Can be done when NuGet/Home#8580 is fixed.

[CPP] Translate `ICli` interfaces from `C#`

Add readonly[const] model to each collection's concepts

Interfaces/cpp/Platform.Interfaces/IDictionary.h

Line 8 in 6c1408e

using Self = std::remove_const_t<RawSelf>;

This is what a small hack looks like
You need to define readonly models that use only const methods

Use .NET Framework 4.7.2 version

.NET Framework 4.7.2 is included in Visual Studio 2019 by default, so there is no need to do separate download of the .NET Framework SDK pack.

Translate Platform.Interfaces to C++

Setup automatic mirroring to GitLab and Bitbucket

It should be possible to replicate deletion of the branch only if it was fully merged.
These replicas can serve as a backup and also make the project easily accessible from multiple places.

Use cmake

To set up multiplatform development environment

Should we rename ISpecificPropertyOperator to IPropertyOperator?

Interfaces/ISpecificPropertyOperator.cs

Line 3 in caa40a3

public interface ISpecificPropertyOperator<TObject, TValue> : IProvider<TValue, TObject>

Sweep: Add `CLinkAddress` concept

Sweep: Add CLinkAddress concept to cpp/Platform.Interfaces/. CLinkAddress must check that argument is integral and unsigned

Checklist

• cpp/Platform.Interfaces/CLinkAddress.h ✅ Commit 0e26908

• Include the `` and `` libraries at the beginning of the file. • Define the `Platform::Interfaces` namespace. • Inside the namespace, define the `CLinkAddress` concept that takes a single template argument `T`. • The concept should check if `T` is both integral and unsigned using `std::is_integral` and `std::is_unsigned` respectively.

Use simplified directory to directory translation to C++ in order to preserve namespaces structure

[c++] include guards

Add

#pragma once

or

#ifndef INCLUDE_GUARD_MACROS_NAME
#define INCLUDE_GUARD_MACROS_NAME
/* code */
#endif  // INCLUDE_GUARD_MACROS_NAME

In all headers

Publish Symbols to GitHub Package Registry

Create `CLinkAddress` concept

CLinkAddress must check that argument is integral and unsigned

Use PackageLicenseExpression

Interfaces/Platform.Interfaces.csproj

Line 15 in f6ba117

<PackageLicenseUrl>https://github.com/linksplatform/Interfaces/blob/master/LICENSE</PackageLicenseUrl>

Fix DocFX warnigns

https://github.com/linksplatform/Interfaces/commit/23516e6165f6afc8052d1c1025c32a5e262d6d7e/checks?check_suite_id=397948922#step:6:132

.NET 5 support

As in actions/runner-images#1891 issue we can start using .NET 5 in the middle of december to make as little as possible changes to repositories.

Related commits:
8ac28ac
d75a64c
1112527

Add ISetter interface

And use it in Setters, and in IPropertyOperator.

Move continuous integration and deploy scripts into separate repository and include them into this repository via GitHub submodule or custom GitHub Actions

Move PDF generation to another virtual machine to speed up the publication

Note: the script from react-deep-tree should be unified with documentation publishing script.

Rename the master branch into main branch

Split these commands into separate steps

Interfaces/.github/workflows/CD.yml

Lines 82 to 83 in 12b34cb

	dotnet build -c Release
	dotnet pack -c Release

The better solution will be to fix #18.

Should we rename IConverter to ITransformer?

Interfaces/IConverter[T].cs

Line 3 in caa40a3

public interface IConverter<T> : IConverter<T, T>

Remove debug output command

Interfaces/.github/workflows/CD.yml

Line 23 in b569ac5

dotnet --version

Should we add header that undefines macros?

https://github.com/linksplatform/Interfaces/blob/master/cpp/Platform.Interfaces/Macros.h

For example, we can name this header as Undefine_Macros.h or UnMacros.h

We could add undefine macros header file to the end of Platform.Interfaces.h do to something like this: https://github.com/linksplatform/Ranges/blob/master/cpp/Platform.Ranges/Range.h

Configure DocFX to generate PDF with documentation.

Internationalization of code comments

Create `CLinks` concept

Member types:

• OptionsType
• LinkAddressType
• LinkType
• WriteHandlerType
• ReadHandlerType
  Members:
• LinksConstants<LinkAddressType> Constants
• LinkAddressType Count(const LinkType& restriction) const
• LinkAddressType Each(const LinkType& restriction, const ReadHandlerType& handler) const
• LinkAddressType Create(const LinkType& restriction, const WriteHandlerType& handler) const
• LinkAddressType Update(const LinkType& restriction, const LinkType& substitution, const WriteHandlerType& handler) const
• LinkAddressType Delete(const LinkType& restriction, const WriteHandlerType& handler) const

Replace the TOKEN with GITHUB_TOKEN

Interfaces/publish-docs.sh

Line 43 in c6784cf

git remote add origin "https://$COMMIT_USER_NAME:$TOKEN@$REPOSITORY.git"

Interfaces/publish-docs.sh

Line 51 in c6784cf

git push "https://$COMMIT_USER_NAME:$TOKEN@$REPOSITORY.git" "$TARGET_BRANCH"

Update NuGet script to a universal version

Interfaces/push-nuget.bat

Lines 1 to 6 in 225321a

	dotnet pack -c Release
	cd bin\Release\
	nuget push -Source https://api.nuget.org/v3/index.json *.nupkg
	del *.nupkg
	del *.snupkg
	cd ..\..

Publish NuGet package to GitHub Registry

https://github.com/orgs/linksplatform/packages?package_type=NuGet

Fix NuGet warnings

WARNING: NU5128: Some target frameworks declared in the dependencies group of the nuspec and the lib/ref folder do not have exact matches in the other location. Consult the list of actions below:
- Add a dependency group for native0.0 to the nuspec
WARNING: NU5048: The 'PackageIconUrl'/'iconUrl' element is deprecated. Consider using the 'PackageIcon'/'icon' element instead. Learn more at https://aka.ms/deprecateIconUrl
WARNING: The <iconUrl> element is deprecated. Consider using the <icon> element instead. https://aka.ms/deprecateIconUrl

Create `CLink` concept

Members:
bool empty()
value_type begin
value_type end
Member types:
value_type

Should we rename ICreteriaMatcher to IPredicateContainer?

Interfaces/ICreteriaMatcher.cs

Line 3 in caa40a3

public interface ICreteriaMatcher<TArgument>

Move C# implementation into csharp folder

This should be repeated for all libraries.

Use updated PNG logo icon

Interfaces/Platform.Interfaces.csproj

Line 13 in f6ba117

<PackageIconUrl>https://raw.githubusercontent.com/linksplatform/Documentation/d65e8dd6e1b647405bc3d33687172e79b70e3435/doc/Avatar-rainbow.png</PackageIconUrl>

New logo icon:
https://raw.githubusercontent.com/linksplatform/Documentation/18469f4d033ee9a5b7b84caab9c585acab2ac519/doc/Avatar-rainbow-icon-64x64.png

Move to Platform.Incrementers

Interfaces/IIncrementer.cs

Line 8 in 7378047

public interface IIncrementer<TNumber>

Should be moved to Counters (after the project is renamed to Incrementers)

Update NuGet push mechanism as at LinksPlatform/Comparers

https://github.com/linksplatform/Comparers

Create DIRECT_METHOD_CALL macro

https://github.com/linksplatform/Data.Doublets/blob/22d79feaef5438c6f4684fa6105583e56129ff79/cpp/Platform.Data.Doublets/ILinksExtensions.h#L527-L531

Macro should simplify direct usage of methods for both static and dynamic polymorphism and the mix of them.
When we have concrete class we should prioritize calling exact method over calling virtual method. If we don’t do that in the case of mixed polymorphism, we can end up with a infinite recursion because call to concrete method might be interpreted as a virtual call.
When we have only abstract class we should just call its virtual method.

It is possible to use variadiac arguments for macro:
https://gcc.gnu.org/onlinedocs/cpp/Variadic-Macros.html

First argument should be a type of class, the second argument should be an instance of the class, the third argument will be the name of the method and rest variadic arguments would be arguments for the method.

Macro should be placed in Macros.h file.

TODO can be use in concepts TObject& instead of TObject

Interfaces/cpp/Platform.Interfaces.Tests/Platform.Interfaces.Tests.cpp

Line 153 in 2d05492

// TODO can be use in concepts TObject& instead of TObject

Move PDF generation to the last step in the separate virtual machine (this will speed up release and package publication)

Interfaces/.github/workflows/CD.yml

Lines 24 to 31 in 6c1408e

	- name: Generate PDF with CSharp code
	if: github.event_name == 'push'
	run: |
	export REPOSITORY_NAME=$(basename ${{ github.repository }})
	wget "$SCRIPTS_BASE_URL/format-csharp-files.py"
	wget "$SCRIPTS_BASE_URL/format-csharp-document.sh"
	wget "$SCRIPTS_BASE_URL/generate-csharp-pdf.sh"
	bash ./generate-csharp-pdf.sh

Should we rename IPropertyOperator to IPropertiesOperator?

Interfaces/IPropertyOperator.cs

Line 3 in caa40a3

public interface IPropertyOperator<TObject, TProperty, TValue>

Should we rename this repository to Abstractions or Concepts?

Interface is a programming language specific term. For example, this term is valid in C#, but there is no such term in C++.

The second idea is to call the entire repository as Concepts.

Anyway, we need a language agnostic word to better reflect the contents of this repository.

[c++] virtual destructors

In c++ interfaces it is necessarily to add a virtual destructor

class A {
public:
virtual void foo() = 0;
/* code */
virtual ~A() = default;  // = 0;
};

otherwise there will be memory leaks

Add LGTM badge