use strict;
use warnings;
package Perl::OSType;
# ABSTRACT: Map Perl operating system names to generic types
our $VERSION = '1.003'; # VERSION

require Exporter;
our @ISA = qw(Exporter);

our %EXPORT_TAGS = (
all => [ qw( os_type is_os_type ) ]
);

our @EXPORT_OK = @{ $EXPORT_TAGS{all} };

# originally taken from Module::Build by Ken Williams et al.
my %OSTYPES = qw(
aix Unix
bsdos Unix
beos Unix
dgux Unix
dragonfly Unix
dynixptx Unix
freebsd Unix
linux Unix
haiku Unix
hpux Unix
iphoneos Unix
irix Unix
darwin Unix
machten Unix
midnightbsd Unix
mirbsd Unix
next Unix
openbsd Unix
netbsd Unix
dec_osf Unix
nto Unix
svr4 Unix
svr5 Unix
sco_sv Unix
unicos Unix
unicosmk Unix
solaris Unix
sunos Unix
cygwin Unix
os2 Unix
interix Unix
gnu Unix
gnukfreebsd Unix
nto Unix
qnx Unix

dos Windows
MSWin32 Windows

os390 EBCDIC
os400 EBCDIC
posix-bc EBCDIC
vmesa EBCDIC

MacOS MacOS
VMS VMS
vos VOS
riscos RiscOS
amigaos Amiga
mpeix MPEiX
);

sub os_type {
my ($os) = @_;
$os = $^O unless defined $os;
return $OSTYPES{ $os } || q{};
}

sub is_os_type {
my ($type, $os) = @_;
return unless $type;
$os = $^O unless defined $os;
return os_type($os) eq $type;
}

1;

__END__

=pod

=head1 NAME

Perl::OSType - Map Perl operating system names to generic types

=head1 VERSION

version 1.003

=head1 SYNOPSIS

use Perl::OSType ':all';

$current_type = os_type();
$other_type = os_type('dragonfly'); # gives 'Unix'

=head1 DESCRIPTION

Modules that provide OS-specific behaviors often need to know if
the current operating system matches a more generic type of
operating systems. For example, 'linux' is a type of 'Unix' operating system
and so is 'freebsd'.

This module provides a mapping between an operating system name as given by
C<$^O> and a more generic type. The initial version is based on the OS type
mappings provided in L<Module::Build> and L<ExtUtils::CBuilder>. (Thus,
Microsoft operating systems are given the type 'Windows' rather than 'Win32'.)

=head1 USAGE

No functions are exported by default. The export tag ":all" will export
all functions listed below.

=head2 os_type()

$os_type = os_type();
$os_type = os_type('MSWin32');

Returns a single, generic OS type for a given operating system name. With no
arguments, returns the OS type for the current value of C<$^O>. If the
operating system is not recognized, the function will return the empty string.

=head2 is_os_type()

$is_windows = is_os_type('Windows');
$is_unix = is_os_type('Unix', 'dragonfly');

Given an OS type and OS name, returns true or false if the OS name is of the
given type. As with C<os_type>, it will use the current operating system as a
default if no OS name is provided.

=head1 SEE ALSO

=over 4

=item *

L<Devel::CheckOS>

=back

=for :stopwords cpan testmatrix url annocpan anno bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan

=head1 SUPPORT

=head2 Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker
at L<https://github.com/dagolden/perl-ostype/issues>.
You will be notified automatically of any progress on your issue.

=head2 Source Code

This is open source software. The code repository is available for
public review and contribution under the terms of the license.

L<https://github.com/dagolden/perl-ostype>

git clone git://github.com/dagolden/perl-ostype.git

=head1 AUTHOR

David Golden <[email protected]>

=head1 CONTRIBUTORS

=over 4

=item *

Jonas B. Nielsen <[email protected]>

=item *

Paul Green <[email protected]>

=back

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by David Golden.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut