vs_projects/miranda
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

mit hyphen

Browse Source
This commit is contained in:
BlubbFish
2013-06-25 22:53:41 +00:00
parent 8896edc368
commit 318d93e6c1
424 changed files with 161843 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Hyphen/Plugins/Docs/COPYING.LESSER.txt
+505
View File
@@ -0,0 +1,505 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 2.1, February 1999
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
[This is the first released version of the Lesser GPL. It also counts
as the successor of the GNU Library Public License, version 2, hence
the version number 2.1.]
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
free software--to make sure the software is free for all its users.
This license, the Lesser General Public License, applies to some
specially designated software packages--typically libraries--of the
Free Software Foundation and other authors who decide to use it. You
can use it too, but we suggest you first think carefully about whether
this license or the ordinary General Public License is the better
strategy to use in any particular case, based on the explanations below.
When we speak of free software, we are referring to freedom of use,
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 this service if you wish); that you receive source code or can get
it if you want it; that you can change the software and use pieces of
it in new free programs; and that you are informed that you can do
these things.
To protect your rights, we need to make restrictions that forbid
distributors to deny you these rights or to ask you to surrender these
rights. These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it.
For example, if you distribute copies of the library, whether gratis
or for a fee, you must give the recipients all the rights that we gave
you. You must make sure that they, too, receive or can get the source
code. If you link other code with the library, you must provide
complete object files to the recipients, so that they can relink them
with the library after making changes to the library and recompiling
it. And you must show them these terms so they know their rights.
We protect your rights with a two-step method: (1) we copyright the
library, and (2) we offer you this license, which gives you legal
permission to copy, distribute and/or modify the library.
To protect each distributor, we want to make it very clear that
there is no warranty for the free library. Also, if the library is
modified by someone else and passed on, the recipients should know
that what they have is not the original version, so that the original
author's reputation will not be affected by problems that might be
introduced by others.
Finally, software patents pose a constant threat to the existence of
any free program. We wish to make sure that a company cannot
effectively restrict the users of a free program by obtaining a
restrictive license from a patent holder. Therefore, we insist that
any patent license obtained for a version of the library must be
consistent with the full freedom of use specified in this license.
Most GNU software, including some libraries, is covered by the
ordinary GNU General Public License. This license, the GNU Lesser
General Public License, applies to certain designated libraries, and
is quite different from the ordinary General Public License. We use
this license for certain libraries in order to permit linking those
libraries into non-free programs.
When a program is linked with a library, whether statically or using
a shared library, the combination of the two is legally speaking a
combined work, a derivative of the original library. The ordinary
General Public License therefore permits such linking only if the
entire combination fits its criteria of freedom. The Lesser General
Public License permits more lax criteria for linking other code with
the library.
We call this license the "Lesser" General Public License because it
does Less to protect the user's freedom than the ordinary General
Public License. It also provides other free software developers Less
of an advantage over competing non-free programs. These disadvantages
are the reason we use the ordinary General Public License for many
libraries. However, the Lesser license provides advantages in certain
special circumstances.
For example, on rare occasions, there may be a special need to
encourage the widest possible use of a certain library, so that it becomes
a de-facto standard. To achieve this, non-free programs must be
allowed to use the library. A more frequent case is that a free
library does the same job as widely used non-free libraries. In this
case, there is little to gain by limiting the free library to free
software only, so we use the Lesser General Public License.
In other cases, permission to use a particular library in non-free
programs enables a greater number of people to use a large body of
free software. For example, permission to use the GNU C Library in
non-free programs enables many more people to use the whole GNU
operating system, as well as its variant, the GNU/Linux operating
system.
Although the Lesser General Public License is Less protective of the
users' freedom, it does ensure that the user of a program that is
linked with the Library has the freedom and the wherewithal to run
that program using a modified version of the Library.
The precise terms and conditions for copying, distribution and
modification follow. Pay close attention to the difference between a
"work based on the library" and a "work that uses the library". The
former contains code derived from the library, whereas the latter must
be combined with the library in order to run.
GNU LESSER GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any software library or other
program which contains a notice placed by the copyright holder or
other authorized party saying it may be distributed under the terms of
this Lesser General Public License (also called "this License").
Each licensee is addressed as "you".
A "library" means a collection of software functions and/or data
prepared so as to be conveniently linked with application programs
(which use some of those functions and data) to form executables.
The "Library", below, refers to any such software library or work
which has been distributed under these terms. A "work based on the
Library" means either the Library or any derivative work under
copyright law: that is to say, a work containing the Library or a
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language. (Hereinafter, translation is
included without limitation in the term "modification".)
"Source code" for a work means the preferred form of the work for
making modifications to it. For a library, complete source code means
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation
and installation of the library.
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does
and what the program that uses the Library does.
1. You may copy and distribute verbatim copies of the Library's
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an
appropriate copyright notice and disclaimer of warranty; keep intact
all the notices that refer to this License and to the absence of any
warranty; and distribute a copy of this License along with the
Library.
You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.
2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) The modified work must itself be a software library.
b) You must cause the files modified to carry prominent notices
stating that you changed the files and the date of any change.
c) You must cause the whole of the work to be licensed at no
charge to all third parties under the terms of this License.
d) If a facility in the modified Library refers to a function or a
table of data to be supplied by an application program that uses
the facility, other than as an argument passed when the facility
is invoked, then you must make a good faith effort to ensure that,
in the event an application does not supply such function or
table, the facility still operates, and performs whatever part of
its purpose remains meaningful.
(For example, a function in a library to compute square roots has
a purpose that is entirely well-defined independent of the
application. Therefore, Subsection 2d requires that any
application-supplied function or table used by this function must
be optional: if the application does not supply it, the square
root function must still compute square roots.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Library, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote
it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Library.
In addition, mere aggregation of another work not based on the Library
with the Library (or with a work based on the Library) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may opt to apply the terms of the ordinary GNU General Public
License instead of this License to a given copy of the Library. To do
this, you must alter all the notices that refer to this License, so
that they refer to the ordinary GNU General Public License, version 2,
instead of to this License. (If a newer version than version 2 of the
ordinary GNU General Public License has appeared, then you can specify
that version instead if you wish.) Do not make any other change in
these notices.
Once this change is made in a given copy, it is irreversible for
that copy, so the ordinary GNU General Public License applies to all
subsequent copies and derivative works made from that copy.
This option is useful when you wish to copy part of the code of
the Library into a program that is not a library.
4. You may copy and distribute the Library (or a portion or
derivative of it, under Section 2) in object code or executable form
under the terms of Sections 1 and 2 above provided that you accompany
it with the complete corresponding machine-readable source code, which
must be distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange.
If distribution of object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the
source code from the same place satisfies the requirement to
distribute the source code, even though third parties are not
compelled to copy the source along with the object code.
5. A program that contains no derivative of any portion of the
Library, but is designed to work with the Library by being compiled or
linked with it, is called a "work that uses the Library". Such a
work, in isolation, is not a derivative work of the Library, and
therefore falls outside the scope of this License.
However, linking a "work that uses the Library" with the Library
creates an executable that is a derivative of the Library (because it
contains portions of the Library), rather than a "work that uses the
library". The executable is therefore covered by this License.
Section 6 states terms for distribution of such executables.
When a "work that uses the Library" uses material from a header file
that is part of the Library, the object code for the work may be a
derivative work of the Library even though the source code is not.
Whether this is true is especially significant if the work can be
linked without the Library, or if the work is itself a library. The
threshold for this to be true is not precisely defined by law.
If such an object file uses only numerical parameters, data
structure layouts and accessors, and small macros and small inline
functions (ten lines or less in length), then the use of the object
file is unrestricted, regardless of whether it is legally a derivative
work. (Executables containing this object code plus portions of the
Library will still fall under Section 6.)
Otherwise, if the work is a derivative of the Library, you may
distribute the object code for the work under the terms of Section 6.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself.
6. As an exception to the Sections above, you may also combine or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse
engineering for debugging such modifications.
You must give prominent notice with each copy of the work that the
Library is used in it and that the Library and its use are covered by
this License. You must supply a copy of this License. If the work
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License. Also, you must do one
of these things:
a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever
changes were used in the work (which must be distributed under
Sections 1 and 2 above); and, if the work is an executable linked
with the Library, with the complete machine-readable "work that
uses the Library", as object code and/or source code, so that the
user can modify the Library and then relink to produce a modified
executable containing the modified Library. (It is understood
that the user who changes the contents of definitions files in the
Library will not necessarily be able to recompile the application
to use the modified definitions.)
b) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (1) uses at run time a
copy of the library already present on the user's computer system,
rather than copying library functions into the executable, and (2)
will operate properly with a modified version of the library, if
the user installs one, as long as the modified version is
interface-compatible with the version that the work was made with.
c) Accompany the work with a written offer, valid for at
least three years, to give the same user the materials
specified in Subsection 6a, above, for a charge no more
than the cost of performing this distribution.
d) If distribution of the work is made by offering access to copy
from a designated place, offer equivalent access to copy the above
specified materials from the same place.
e) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy.
For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it. However, as a special exception,
the materials to be distributed need not include anything that is
normally distributed (in either source or binary form) with the major
components (compiler, kernel, and so on) of the operating system on
which the executable runs, unless that component itself accompanies
the executable.
It may happen that this requirement contradicts the license
restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.
7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
library, provided that the separate distribution of the work based on
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:
a) Accompany the combined library with a copy of the same work
based on the Library, uncombined with any other library
facilities. This must be distributed under the terms of the
Sections above.
b) Give prominent notice with the combined library of the fact
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
8. You may not copy, modify, sublicense, link with, or distribute
the Library except as expressly provided under this License. Any
attempt otherwise to copy, modify, sublicense, link with, or
distribute the Library is void, and will automatically terminate your
rights under this License. However, parties who have received copies,
or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
9. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Library or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Library (or any work based on the
Library), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Library or works based on it.
10. Each time you redistribute the Library (or any work based on the
Library), the recipient automatically receives a license from the
original licensor to copy, distribute, link with or modify the Library
subject to these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties with
this License.
11. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
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
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Library at all. For example, if a patent
license would not permit royalty-free redistribution of the Library by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Library.
If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply,
and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
12. If the distribution and/or use of the Library is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Library under this License may add
an explicit geographical distribution limitation excluding those countries,
so that distribution is permitted only in or among countries not thus
excluded. In such case, this License incorporates the limitation as if
written in the body of this License.
13. The Free Software Foundation may publish revised and/or new
versions of the Lesser 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 Library
specifies a version number of this License which applies to it and
"any later version", you have the option of following the terms and
conditions either of that version or of any later version published by
the Free Software Foundation. If the Library does not specify a
license version number, you may choose any version ever published by
the Free Software Foundation.
14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these,
write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this. Our
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE LIBRARY "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
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE LIBRARY 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
LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change. You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of the
ordinary General Public License).
To apply these terms, attach the following notices to the library. It is
safest to attach them to the start of each source file to most effectively
convey 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 library's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Also add information on how to contact you by electronic and paper mail.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the library, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
<signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!
Hyphen/Plugins/Docs/CodingConventions.txt
+12
View File
@@ -0,0 +1,12 @@
THREAD SYNCHRONIZATION ===
=============================================================================
- If there is a SynchronizationSupervisor::BeginXXXUpdate() method,
then this method should be used to lock on a XXX variable type instead
of the lock statement
- for example, if there is a BeginDescriptorUpdate() method, then
you should use this method to lock on a Descriptor typed variable
- If there is no associated method in the SynchronizationSupervisor class,
then the lock statement should be used instead
- Previous two recomendations were introduced to ensure the coding consistency
in the thread synchronization on types being frequently passed as arguments
Hyphen/Plugins/Docs/Desktop.ini
+3
View File
@@ -0,0 +1,3 @@
[.ShellClassInfo]
IconFile=%SystemRoot%\system32\SHELL32.dll
IconIndex=126
Hyphen/Plugins/Docs/History.txt
+304
View File
@@ -0,0 +1,304 @@
HYPHEN Version History
==========================================================================================================
KNOWN ISSUES
==========================================================================================================
- ContactInfo.Read/WriteSetting & ContactInfo.WriteSettingAsBlob do not support blob values yet
- MirandaDatabase.ContactSettingChange event does not provide data for changed blob values (see prev point)
v0.8.6.1931
==========================================================================================================
* MANY BINARY INCOMPATIBLE CHANGES
* MirandaContext completely refactored
- Service functions => ServiceManager
- Events + Event hooks => EventManager
+ MirandaContext.ServiceCallInterceptors
- Plugin dialogs tracking rewritten to be more efficient and deadlock free :-)
- EventHandle class refactored (see EventManager)
- DatabaseEventInfo.Data encoding bug fixed
- Internal text encoding mishandling fixed
+ LoaderOptions.MinimalMirandaVersion added
+ Hyphen tray icon moved to Hyphen's menu
v0.8.5.1502
==========================================================================================================
- MirandaDatabase.AddEvent encoding bug fixed
- MirandaDatabase.GetContacts/FindContact methods rewritten to be more efficient
+ ContactInfo.OpenMessageWindow()
* MirandaContext.UnhookEvent(MirandaPlugin, string) => MirandaContext.UnhookEvent(string, MirandaPlugin)
* IConfigurablePlugin interface undergone incompatible binary change
v0.8.5.1303
==========================================================================================================
+ Codename Casablanca - new configuration infrastructure
+ ContactList.AddEvent method introduced
+ AckRouter class for protocol ack processing introduced
+ Protocol.StatusChanged event introduced
+ Stability improvements
+ Exception handling improvements
- LangPack string encoding fixed
- Other bug fiexes
- Internal refactoring
* MirandaContext.NetworkProtocols => MirandaContext.Protocols
* NetworkProtocolDictionary => ProtocolDictionary
* A few events refactored
* A few classes renamed
v0.8.5.1101
==========================================================================================================
- 0.7+ Miranda Plugin API conformance
v0.8.5.1
==========================================================================================================
- Minor stability fix
v0.8.5.0
==========================================================================================================
* Virtuoso.Hyphen.Sandbox renamed to Virtuoso.Miranda.Plugins.Helpers.Sandbox
* ProtocolPlugin.Descriptor renamed to ProtocolPlugin.ProtocolDescriptor
+ MenuItemDeclarationAttribute can be now applied to methods as well without the need to specify
the service name; the service will be created for the method automagically
+ Virtuoso.Miranda.Plugins.Helpers.MessageQueue class introduced
* GenericEventArgs renamed to MirandaEventArgs
* Many *EventArgs classes renamed
- FIXED BUG: BeforeEventAdded event now does provide valid event data
v0.8.4.1
==========================================================================================================
* Many interfaces refactored,
- Critical interop bug fixed (thanks to MikZ)
v0.8.4.0
==========================================================================================================
- MPM bug fixes
* Configuration class renamed to PluginConfiguration,
v0.8.4.0
==========================================================================================================
* MirandaDatabase class + several other APIs overhauled,
+ Managed protocol support (see the MPM project on my site)
v0.8.3.2
==========================================================================================================
+ Configuration dialog revisited
v0.8.3.1
==========================================================================================================
+ Main menu popup menus support for managed plugins
+ Updated version of CueBannerTextBox included
+ InformationDialog introduced
+ New 'Loading plugins' dialog introduced
- FIXED BUG: Plugin settings not saved with LazyUnload feature enabled
v0.8.3.0
==========================================================================================================
- Incompatible binary changes, plugins must be recompiled
+ Plugin configuration framework introduced
+ Vista style introduced
+ Lazy unload introduced
+ CueBannerTextBox control included (nice work of Chili Software)
+ GradientPanel control included
+ Hyphen configuration revisited
- Many internal changes
v0.8.2.60
==========================================================================================================
- Hyphen is now strong named because some plugins may need to be strong named so Hyphen must be too
- Plugins will automatically load the newest version of Hyphen; this is done using the BindingRedirect
to avoid multiple versions of Hyphen assemblies to be deployed
* Incompatible binary changes, plugins must be recompiled
v0.8.2.25
==========================================================================================================
- I haven't accounted .NET Remoting object lifetime so after 5 minutes, all the remote objects
are disconnected, which is very bad => fixed by overriding the MarshalByRefObject::InitalizeLifetimeService
method
- If you're designing an object accessible from another AppDomain (for example if you're using
the Sandbox class), derive it from the Virtuoso.Miranda.Plugins.Infrastructure.RemoteObject class
to make it connected as long as it's not collected by GC
v0.8.2.20
==========================================================================================================
- ConfigurableMirandaPlugin class introduced; provides plugins with a seamless configuration store
v0.8.2.0
==========================================================================================================
- Icons refreshed
- Various internal changes
- Sandbox class introduced; allows you to easily sandbox your own plugins (in plugins :-)) or scripts
v0.8.1.80
==========================================================================================================
- Langpack localization support via the LanguagePack, LanguagePackStringResolver & LocalizableForm classes
- Hyphen's main menu items now take advantage of Langpack (I'm not going to localize dialogs using Langpack,
(at least not now), I prefer the .NET way, i.e. satelite assemblies)
v0.8.1.60
==========================================================================================================
- Updater plugin support (Virtuoso.Miranda.Plugins.ThirdParty.Updater.UpdaterPlugin class)
- LoaderOptionsAttribute now supports required Hyphen version specification; Hyphen refuses to load a plugin
that requires a newer version of Hyphen
v0.8.1.40
==========================================================================================================
- Internal stability improvements
v0.8.1.35
==========================================================================================================
- Virtuoso.Miranda.Plugins.Helpers.IniStructure class added; thanks kratchkov@inbox.lv for his
CodeProject submission!
v0.8.1.32
==========================================================================================================
- ContactInfo.Value is now translated to ANSI string by default not to Miranda's build default encoding.
v0.8.1.30
==========================================================================================================
- Internal sandboxing API changes
v0.8.1.10
==========================================================================================================
- Safe callbacks introduced; no managed plugin should now crash Miranda with an unhandled exception;
an exception will be caught and processed by a callback stub
v0.8.1.4
==========================================================================================================
- Internal refinements
v0.8.1.3
==========================================================================================================
- Internal Loader changes
- Internal Hyphen.Mini changes
v0.8.0.0
==========================================================================================================
- Midas is now Hyphen, the core has been re-engineered...
- Hyphen now supports delayed plugin loading and unloading; plugins are not loaded on startup but you can load
them using the Miranda Menu - 'Load/Unload Microsoft.net plugins' item; this saves memory and startup time
- EventHandle class providing you with an option to create and manage your own events
- MirandaContext now offers CreateServiceFunction and HookEvent methods
- You can override the builtin configuration and use your own Plugin manager instead of the builtin one
- You can override the builtin configuration and use your own Assembly probe to search for plugins
in custom directories
- You can manage plugins via a Hyphen manager icon in the tray
- Plugin assemblies are now shadow copied so you can update them on the fly and Hyphen will reload them
without the need of restarting Miranda
- Noticable performance improvements introduced; unsafe C# pointers employed to get rid of many copying
operations
- Bunch of new functionality added, see for yourself; I am unable to track that amount of changes ;)
v0.7.2.0
==========================================================================================================
- Midas.dll and Virtuoso.Miranda.Plugins were merged into the Midas.dll assembly
v0.7.1.10
==========================================================================================================
- Internal tuning
- InteropBufferPool now offers an override allowing you to set the buffer capacity
- note that a new buffer will be allocated if you explicitly set a capacity higher than the default one,
which is 260 bytes
v0.7.1.5
==========================================================================================================
- InteropBuffer class revamped to be more robust
- InteropBufferPool class introduced; it manages a few shared buffers and when an additional
buffer is requested, it allocates a one
- to obtain an instance of a buffer, you have to call the InteropBufferPool::AcquireBuffer() method
- you will be provided with an instance of capacity 260 bytes
- to release a buffer and free its resources, call the InteropBufferPool::ReleaseBuffer(InteropBuffer)
method; a buffer to be released must be unlocked!
- MirandaContext::CreateHookableEvent method provided; returns an instance of the EventHandle class
allowing you to manipulate with the event (fire it and set a default hook)
v0.7.1.1
==========================================================================================================
- Minor internal changes
- IcqXStatusPlugin source code included (note it requires Unicode Miranda and the latest ICQOscarJ plugin)
v0.7.1.0
==========================================================================================================
- MirandaContext::PluginSettingsManager property now returns null; please do not use this class, it will be
refactored in the future
- MirandaDatabase::GetProfileName() & ::GetProfilePath() methods added
- Translate::ToString() method now supports length and encoding options; you can now specify an encoding
in which is a string pointed by a handle encoded in or select StringEncoding::MirandaDefault to assume
ANSI under the non-unicode Miranda core and UNICODE under the unicode-aware Miranda core;
using this method will simplify possible unicode transition in the future
- MirandaEnvironment static class introduced; you can use it to obtain the information about Miranda
(currently there is a MirandaStringEncoding property only)
- InteropBuffer class introduced; you can pass it to a Miranda service expecting a char/byte/whatever
buffer pointer; just don't forget to Lock() and Unlock() it before and after the use, respectively
- to obtain a buffer pointer, you the IntPtr property;
- WARNING: do not call the Free()/Dispose() methods (!!!) these will invalidate the buffer and prevent
its next use; these methods are supposed to be called by internal callers only!
- to purge the content of the buffer (if security is your concern), use the Zero() method
- note that the Zero() operation is quite a slow one, so carefully consider its use
- to obtain the capacity of the buffer, use either the InteropBuffer::Capacity or ::CapacityAsXX fields
v0.7.0.5
==========================================================================================================
- MirandaDatabase now supports writing and reading contact settings; reading is done via
a "DB/Contact/GetSettingStatic" service call to improve performance
v0.7.0.1
==========================================================================================================
- Midas v1.0.0.1 included; minor internal API changes
v0.7.0.0
==========================================================================================================
- DotNetConnector is now Midas
- Miranda-2-.net proxy is now pure IL with 3 unmanaged exports only representing the Miranda API entry
points (previously there was an C++/CLI IJW assembly dependent on the MS VCRT v8.0 dlls; this is now gone)
- No public API changes
v0.6.8.0
==========================================================================================================
- PluginSettings class for storing plugin specific settings
- MirandaDatabase class extended
- IndividualMirandaPlugin class added; you can derive your plugins from it and use a small
IL stub to create plugins that are not managed by the PluginManager and thus can override Miranda system modules
and are even transient
- More documentation will code...
- Project <no-codename-yet> has been started; it's goal is to replace the C++/CLI loader stub with a pure
IL stub consisting from 3 unmanaged exports only...
v0.6.7.0
==========================================================================================================
- MenuItemDeclarationAttribute API refactored
- StandardServices & StandardEvent class removed
- ContactList now supports adding and modifying menu items
- Some collection changes
- ContactList.ProtocolStatusChange event added
v0.6.6.0
==========================================================================================================
- All previous known issues resolved (probably caused by some hook-twice operation)
- PluginContext is now MirandaContext
- PluginContext.MirandaPInvokeBridge is not public now, it was visible due a bug
- Miranda lazy event binding introduced (binds to Miranda's internal event only when somebody subscribes
a one)
- PrivatePluginAttribute introduced (makes a plugin manually loadable only, fusion will ignore it)
v0.6.5.0
==========================================================================================================
- Some optimalizations
- KNOWN ISSUES
- MirandaDatabase::EventAdded event fired twice. I think Miranda does this, but don't know why...
v0.6.3.0
==========================================================================================================
- Bunch of new stuff added, see for yourself...
v0.5.8.0
==========================================================================================================
- Contact info query support
- UnmanagedStructHandle´1 struct made public for use
(can be used for easy unmanaged memory allocation and deallocation)
- Performance and stability tuning
- MirandaPlugin base class expansion; some new virtual methods added
- Threaded fusion
v0.5.0.0
==========================================================================================================
- initial alpha release
Hyphen/Plugins/Docs/README.txt
+71
View File
@@ -0,0 +1,71 @@
HYPHEN SRC README
===================================================
© 2006 - 2009, virtuoso
deml.tomas@seznam.cz
v0.8.2009.0201
PREREQUISITES
===================================================
- Microsoft Visual Studio 2008 (no Express editions)
Full MS VS 2k8 is required because the build
solution features multilanguage projects.
(NMAKE, C#)
- Microsoft .NET 2.0 SDK
SOLUTION
===================================================
- In \Virtuoso.Hyphen\Virtuoso.Hyphen.sln
- HYPHEN project should be set as START PROJECT
- PLUGINS project
This is a C# project with Miranda .NET API.
It is build with VS and then disassembled using IlDasm.exe
into the Plugins.IL file.
- HYPHEN project
This is an NMAKE project containing an MSIL stub
which acts as a bootstrapper for MS.NET.
It merges the Plugins.il with the LoaderStub.il
into a single Hyphen.dll assembly using IlAsm.exe.
- HYPHEN.MINI project
This is an NMAKE project containg custom MSIL stub
for database and protocol plugins which cannot
be loaded with Hyphen directly.
HOW TO BUILD
===================================================
- 1) Include
"%WINDIR%\Microsoft.NET\Framework\v2.0.50727" and
"%PROGRAMFILES%\Microsoft Visual Studio 8\SDK\v2.0\Bin"
in the PATH variable.
These paths contain IlAsm.exe and IlDasm.exe respectively
which are needed during the build process.
- 2) Open the solution.
- 3) Switch to the release configuration.
- 4) Open the Hyphen project properties and change
the Output directory to point to
%YOUR_MIRANDA_FOLDER_GOES_HERE\Plugins directory.
- 5) Press F6 to build the solution. You should see
IlAsm output in the output window and IlDasm window
with progress bar.
- 6) Once it's done, you should find Hyphen.dll in your
Miranda\Plugins directory.
PROBLEMS
===================================================
- If you are getting "Failed to define document writer"
errors during the build, make sure the
Hyphen\Bin\(CONFIG_NAME_HERE) folder exists.
CONFIG_NAME_HERE stands for Debug or Release.
- Feel free to !MAIL! me in case of problems.
SOURCES
===================================================
Source codes are mostly undocumented (unfortunately).
Hyphen/Plugins/Docs/SDK Docs/index.htm
+212
View File
@@ -0,0 +1,212 @@
<html>
<head>
<meta http-equiv="Content-Language" content="cs">
<title>Midas SDK Docs</title>
<style>
<!--
body { font-family: Tahoma; font-size: 10pt }
-->
</style>
</head>
<body>
<h1>Midas SDK Documentation v1.0</h1>
<h4>Miranda .net Association Plugin SDK, © 2006 Virtuoso</h4>
<h3>Contents</h3>
<ul>
<li>Overview</li>
<li>Architecture</li>
<li>Namespaces<ul>
<li>Key namespaces</li>
<li>Native interop namespaces</li>
</ul>
</li>
<li>Classes<ul>
<li>Key classes<ul>
<li>Plugin definition/construction classes</li>
<li>Miranda API wrapper classes</li>
</ul>
</li>
<li>Native interop classes</li>
<li>Helper classes</li>
</ul>
</li>
<li>A Hello World plugin Walkthrough</li>
</ul>
<p>&nbsp;</p>
<h3>Overview</h3>
<p>Midas (Miranda .net Assocication Plugin) is a plugin allowing Microsoft.net
platform developers to access Miranda APIs thus allowing them to write Miranda
targeted managed plugins.</p>
<p>I created Midas because I'm an avid C# programmer and I wanted to extend
Miranda in an easy, reliable and fast way - with Microsoft.net managed plugins.</p>
<p>You can write Miranda plugins in any Ecma CLI compliant language, for example
C#, J#, Delphi, C++/CLI or Visual Basic.net. Please note that you may not be
able to take advantage of all Midas features from languages that do not support
some CLS non-compliant constructs. You may have problems using Microsoft Visual
Basic.net because it, for example, does not support unsigned data types. Miranda
and Midas use these types (System.UIntPtr) extensively.</p>
<p>In a nutshell, Midas represents a native-to-managed wrapper presenting core
Miranda APIs in the OO fashion to .net. It wraps Miranda's procedural APIs to a
neat and logical object oriented interface.</p>
<p>Using Midas, you can write Miranda plugins that you or anybody else find
useful. With .net plugins, you can accomplish complicated and complex tasks in
the much faster way.</p>
<p>&nbsp;</p>
<h3>Architecture</h3>
<p>Midas consinsts of two crucial assemblies:</p>
<ul>
<li><b>Midas.dll</b><ul>
<li>this assembly was written in IL (Intermediate Language) and contains 3
unmanaged exports exposing required unmanaged plugin API exports to Miranda</li>
<li>previously, there was an C++/CLI assembly but it's maintentace was not
as easy as it ought to be (and me, primarily .net programmer, concluded a
pure IL assembly as a more transparent way to accomplish the connection with
Miranda than the opaque IJW magic C++/CLI compiler uses)</li>
<li>this assembly instantiates the Virtuoso.Midas.Loader class that provides
Miranda with a PLUGININFO information and initiates the .net plugins fusion</li>
</ul>
</li>
<li><b>Virtuoso.Miranda.Plugins.dll</b><ul>
<li>this assembly was written in safe C# and exposes unmanaged Miranda APIs
to the .net world</li>
<li>in this assembly, there is the Virtuoso.Miranda.Plugins.PluginManager
type (not publicly exposed) that finds, loads and initiates all the managed
plugins in the &lt;mirandaFolder&gt;\plugins\managed folder</li>
<li>this assembly is the one you will want to reference on your plugin's
compile time</li>
<li>this assembly also contains the most important type for us, developers,
the Virtuoso.Mirandas.Plugins.MirandaPlugin class representing the base
class for all of your plugins</li>
</ul>
</li>
</ul>
<p>&nbsp;</p>
<h3>Namespaces</h3>
<p>There are many publicly visible namespaces containing key classes and many
native interop helper classes making easy to access not yet wrapped parts of the
Miranda API.</p>
<h5>Key namespaces:</h5>
<ul>
<li><b>Virtuoso.Miranda.Plugins</b><ul>
<li>contains funtionality concerning the plugin fusion, maintentace,
definition and construction</li>
</ul>
</li>
<li><b>Virtuoso.Miranda.Plugins.Infrastructure</b><ul>
<li>contains all the functionality you may need to develop your plugins;
provides Database, Contact List, Contact Information, Network Protocol and
many other Miranda API wrappers</li>
<li>also contains some helper classes you may find useful
(unmanaged-to-managed data translation services and localization helpers)</li>
</ul>
</li>
<li><b>Virtoso.Miranda.Plugins.Infrastructure.IndividualMirandaConnection</b><ul>
<li>contains additional helper classes for plugins not managed by the
Microsoft.net plugins supervisor</li>
</ul>
</li>
<li><b>Virtuoso.Miranda.Plugins.ObjectCollections</b><ul>
<li>contains specialized object collections</li>
</ul>
</li>
</ul>
<h5>Native interop namespaces:</h5>
<ul>
<li><b>Virtuoso.Miranda.Plugins.Native</b><ul>
<li>contains types you may use when you need to directly interface with
Miranda APIs; provides you with unmanaged memory, string and struct handles</li>
</ul>
</li>
</ul>
<p>&nbsp;</p>
<h3>Classes</h3>
<p>There are several classes representing the Miranda API wrappers for Database,
Contact List and many other aspects of Miranda API model.</p>
<h5>Key classes:</h5>
<ul>
<li>
<h5>Plugin definition/construction classes</h5>
<ul>
<li>
<h5>Virtuoso.Miranda.Plugins namespace</h5>
<ul>
<li><b>abstract MirandaPlugin</b><ul>
<li>represents a base class for all .net plugins</li>
<li>to define a plugin, derive your class from this one, implement
required abstract members and you are ready to go</li>
<li><b>members</b><ul>
<li><b>methods</b><ul>
<li><b>protected</b><ul>
<li><b>void .ctor()</b><ul>
<li>Initializes an instance of the MirandaPlugin class</li>
</ul>
</li>
<li><b>virtual void AfterPluginInitialization() </b>
<ul>
<li>executed after the first plugin initialization</li>
<li>executed only once a Midas lifetime</li>
<li>use this method to initialize your plugin after Miranda
startup, for example for additional event hook-ups</li>
<li>DO NOT EXECUTE ANY TIME CONSUMING CODE IN THIS METHOD
NEITHER SHOW ANY WINDOWS FORMS</li>
</ul>
</li>
<li><b>virtual void AfterMenuItemsPopulation()</b><ul>
<li>executed after the plugin menu items detection</li>
<li>executed only once a Midas lifetime</li>
<li>use this method to change properties or manipulate with your
plugin menu items</li>
<li>DO NOT EXECUTE ANY TIME CONSUMING CODE IN THIS METHOD
NEITHER SHOW ANY WINDOWS FORMS</li>
</ul>
</li>
<li><b>virtual void AfterPluginEnable()</b><ul>
<li>executed right after a plugin is enabled by the
user/supervisor</li>
<li>executed every time a plugin is enabled</li>
<li>DO NOT EXECUTE ANY TIME CONSUMING CODE IN THIS METHOD
NEITHER SHOW ANY WINDOWS FORMS</li>
</ul>
</li>
<li><b>virtual void BeforePluginDisable()</b><ul>
<li>executed right before a plugin is disabled by the
user/supervisor</li>
<li>use this method to unhook events or destroy service
functions you created manually; events and services declared
through attributes will be unhooked/destroyed automatically by
the plugin supervisor</li>
<li>DO NOT EXECUTE ANY TIME CONSUMING CODE IN THIS METHOD
NEITHER SHOW ANY WINDOWS FORMS</li>
</ul>
</li>
<li><b>virtual void BeforeMirandaShutdown</b><ul>
<li>executed right before Miranda or the plugin supervisor is
shutdown</li>
<li>use this method to perform possible memory cleanup</li>
<li>DO NOT ALLOCATE NEW MEMORY NEITHER INTERFACE WITH MIRANDA
THROUGH WRAPPERS OR NATIVE INTEROP FROM THIS METHOD; MIRANDA IS
ABOUT TO SHUTDOWN AND MANY OF ITS APIS ARE NO LONGER AVAILABLE;
USE THE BEFOREPLUGINDISABLE() METHOD INSTEAD</li>
<li></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</body>
</html>